クリーンコード とは？

読む人が意図を理解し、変更しやすいコードだよ。例えば長方形の面積なら、値の意味が分からない w * h より、width * height とすると幅と高さだと分かる。ただし短い名前でも、その文脈で意味が明らかなら使えるんだ。

修正やレビューでは、既存のコードが何をしているか理解する必要があるからだよ。名前や構造が目的を伝えれば、その理解を助けられる。読む時間の割合や効果を一律の数値で決めるのではなく、実際に読む人の分かりやすさを確かめよう。

まとまりのある仕事が分かる単位にしよう。分けすぎると、あちこちを追わないと理解できなくなるよ。単一責任の原則は、モジュールが変更される理由を1つにするという考え方で、「関数の命令を1個にする」という意味ではないんだ。

必要なコメントは残そう。名前や構造で分かる処理を繰り返すより、なぜこの設計にしたか、なぜ特殊な処理が必要かを説明すると役立つよ。複雑な式やアルゴリズムでは処理の説明が必要なこともある。変更したらコメントとの食い違いも直そう。

まず変えてはいけない動作を確かめ、テストなどで確認しながら小さく変更しよう。リファクタリングは外から見た動作を保って内部構造を改善することだよ。名前の変更や処理の整理を少しずつ行い、不要な抽象化や細分化を増やさないようにするんだ。