📖
リーダブルコード「より良いコードを書くためのシンプルで実践的なテクニック」
1章 理解しやすいコード
短いコードが優れているのか、長いコードが優れているのか。。。
他の人が最短時間で理解できるコード→未来の自分が最短時間で理解できるコード
を意識して書くことが大事。
できれば短いコードであると尚良いらしい。
2章 名前に情報を詰め込む
プログラムに使われる名前で名前のつけ方を工夫する6点
・明確な単語を選ぶ
GetPage()というメソッドがあるとして、このメソッドはどのページから取ってくるのか？
getでは、曖昧な表現になってしまうらしい。。。
→DownLoadPage()やDesktopPage()というメソッドの方がどのページからとったメソッドか明確になりやすい
・汎用的な名前を避ける
tmp(一時的な)やretval(戻り値)のような汎用的に使用される値を使ってしまうと、意味が明確になりにくい。単なる意味の薄い名前を怠慢になるので、命名には意味のある単語を使うように心がけるようにしたい。
・接尾辞や接頭辞を使って情報を追加する
second()というメソッドがある場合、それが分(秒)であればms_や時間(秒)であればhs_を接頭辞に加えることで、よりメソッド名に具体的な意味を持たせると良い。
・名前の長さを決める
スコープが数画面に及ぶものに関しては変数を短くしすぎてはいけず、数行になるものは短くても良い。
・名前のフォーマットで情報を伝える
大文字やアンダースコアなどを使って意味を持たせてメソッド名をつけると良い。
3章 誤解されない名前
・メソッド名を決める時は、filter,length,limitなど曖昧な単語は使わない。
・上下の限界を決める時はmax_,min_を前につける。
・包括的範囲を決める時はfirst,lastを使う。
・包括/排他的範囲であればbeginとendを使う。
常に誤解されないかと意識して名前を決める。
4章 美しさ
・コードの列を整列させる。
・A-B-Cと並べているものをB-C-Aのように並べ替えない。意味のある順番であるため、並べ替えないこと。
・空行を使って、ブロックを段落ごとに分け。
5-6章 コメントについて
・基本的なコードのルールに対するコメントは書かないこと。書かずにコード自体を修正すべき。
・定数や変数にまつわる背景など。
・クラスには全体像に関するコメントを書く。
・関数に関する説明。
・代名詞に「それ」「これ」といった曖昧な代名詞を使用しない。
・よくわからない引数にインラインコメントを使う