リーダブルコードまとめ
-
わかりやすい命名
function名を見て何を表す・実行するのかわかる -
わかりやすく無駄のないコメント
他人がコードを読むとき素早く理解できるようにする -
シンプルで美しいロジック
シンプルなロジックを組む
修正しやすく、不具合が少ないのがメリット
命名に関して
a b fooなどの意味のない変数名は使わない
ユーザー名だったらuserNameなど何を表すかわかるようにする
データベース名と揃えるなど
誤解を招く表現は避ける。
filterというファンクション
filterではなく、selectやexcludeを用いる。
コメントに関して
なぜコメント使うのか。
昨日の自分は他人という格言もある。
他の人がコード見たときに、誤りなく素早く内容を理解するため
コードを変更する際はコメントも変更すること
コメントに書くべき内容としては、実装の背景にある自分の考えや、コードから読み取れない補足情報
設計書との関連付け
処理ブロックに関してもコメントを残す。
ただ、コードを見たらわかる内容はコメント残さないように。
可能な限り簡潔に
整理とかインデントに関して
コードやコメントは整理整頓しよう。
-
助長な部分は排除する
不要なelseを削除する -
可能な限り否定系は避ける
unlessなどの否定系は使わない
elseなどを使う。 -
エラーの少ない記述を心がける。
エラーの少ない記述を心がける。
nullチェックを心がけたり。