※自分用メモです。随時、変更・追記してきます。
基本的に以下の書籍を参考にしています。
- リーダブルコード
- CleanCode
大前提
- 理解しやすいコードであること
- 一度に一つのことを行うこと
名前
- 気取った名前より、意味の伝わる名前であること
コメント
- コメントすべきではないこと
- コードからすぐに推測できるようなこと
- 変更内容の履歴のような日誌コメント
- コメントすべきこと
- 情報を与えるコメント
- なぜそうしたのか、意図を伝えるコメント
- 結果に対する警告コメント
- TODOコメント
制御フロー
- ネストは浅くすること
- 説明変数を利用すること
- 要約変数を利用すること
変数
- スコープは小さいこと
関数
- 小さいこと
- 一つのことを行なっていること
- 引数は少ないこと
- フラグ引数は極力使わないこと
- 副作用を避けること
- DRY原則
クラス
- 小さいこと
- 単一責任の原則
- 凝集性が高いこと
- オープン/クロースドの原則
- 依存性逆転の原則