読みやすいコードを書く
1. 原則
読みやすいコードは保守性が高い
- 読みやすく理解しやすいコードは、一般的に作成者当人以外にも理解が容易である保守が容易である
- ソースコードは読みやすいことを優先し、読みにくく理解に労力を要するコードは除去されるべきである
2. 根拠
ソースコードは人間が読むものである
- ソースコードは人間が読むために記述されるものであるため、人間に理解しやすく記述されなくてはならない
- CPU資源が乏しい時代においては処理効率を優先したコード（＝人間が読みにくいコード）を書くことが推奨されたこともあったが、2010年以降における一般的な状況では処理効率を優先したコードを書くべき場面はあまり多くない
読みにくいコードは後々まで祟る
- 読みにくいコードは内容の理解が困難である為、修正のリスクが高く、その部分だけいつまでもメンテナンスされず、パッチワーク的な修正がされがちである
- パッチワーク的修正が累積したコードは早晩全容を把握できるエンジニアがいなくなり、メンテナンス不能に陥る
- メンテナンス不能に陥ったコードは機能追加も不具合修正も困難な生き腐れた状態になり、システムの資産価値を毀損する
- 読み難く、理解が困難なコードは、それをメンテナンスするエンジニアのモチベーションに影響し、エンジニアの定着率に大きな影響を及ぼす
3. 指針
技巧的なコードを書かない
- エンジニアは合理的な理由なく複雑さや技巧に偏重したコードを書くことを避けねばならない
- 複雑で技巧的なコードを書いてエゴを満たすのはプライベートの活動に留める
最適化は後回しでよい
- 実行効率の最適化をするために読みにくいコードを書いてはならない
- 実行効率の最適化は実際にプログラムの処理速度を計測し、処理速度が問題になってから行えばよい
保守性の高いコードの書き方を学ぶ
- 保守性の高いコードの書き方は意識的に学ばないと身に付くことはない為、継続的に学習しなければならない
4. 注意
参考資料