概要
「リーダブルコード より良いコードを書くためのシンプルで実践的なテクニック」を読んだので、自分なりに今後開発をする上で参考になりそうな点などを備忘録としてまとめました。
なにかご指摘などあれりましたら、メッセージをいただけると幸いです。
2章 名前に情報を詰め込む
・クラス名、関数名など名前をつける際に、何を目的とするのか情報を持たせる
・名前をつける際、明確で正確なものにする
・「tmp」、「it」、「retval」など汎用的に使われる名前を使用する時は、使用する理由を明確にしておく
・変数名をつける際、セキュリティの問題や、変数名の意味を間違えた際にバグになりそうな箇所には、属性を追加する
3章 誤解されない名前
・名前をつける際に、使用する名前が他の意味にとらわれないかを考える
・bool値の変数名は、「is」、「has」、「can」、「should」などを頭につけて分かりやすくする
4章 美しさ
・コードからすぐ分かることは、コメントに書かない
5章 コメントすべきことを知る
・コメントは、コードを書いている時の考えを記載する。
・コードに欠陥がある際に使用するコメント
「TODO:」 → 後で手をつける場合
「FIXME:」 → 既知の不具合がある場合
「HACK:」 → 解決策があまりキレイじゃない場合
「XXX:」 → 大きな問題がある場合
6章 コメントは正確で簡潔に
・コメントを書く際に、「それ」や「これ」などの代名詞は使用しない
・関数の動作はできるだけ正確に説明する
7章 制御フローを読みやすくする
・行数を短くすることよりも、誰が見ても理解しやすいコードを記載する
・条件分岐の際は、基本if-else文を使用する。三項演算子は簡潔になるときだけ使用する。
8章 巨大な式を分割する
・ひとつのコードの式が大きくなると理解が難しくなるため、分割するようにする。
12章 コードに思いを込める
・コードを明確にする手順
1.コードの動作を簡単な言葉で誰にでも分かるように説明する
2.その説明の中で使用しているキーワードやフレーズに注目する
3.その説明に合わせてコードを書く
13章 短いコードを書く
・コードをできるだけ小さく軽量に維持するために
・汎用的な「ユーティリティ」コードを使用し、重複コードを削除する
・未使用のコードや無用な機能を削除する
・コードの重量を意識し、軽量で機敏にしておく
・使用するライブラリは、中を見て機能を熟知しておく
14章 テストと読みやすさ
・他のプログラマが安心してテストの追加や変更ができるように、テストコードを読みやすくする
・テストに使用する値は、キレイで単純なものを使用する
15章 「分／時間カウンタ」を設計・実装する
・外部の視点を入れる
半年後の自分も含め、誰が読んでもユーザーフレンドリーな状態を保つ