はじめに
第6章では「コメントの書き方」がテーマでしたが、本質は「コードを読む人の立場になってコメントを残すこと」に尽きると感じたため、本記事では第7章の学びを整理します。
第7章での学び
条件式の可読性を上げる法則
条件式は、「変化する値を左側に、固定的な比較値を右側に」書くと読みやすくなる、という話。
たとえば、
if (length > 10)
の方が、
if (10 < length)
よりも読みやすい。
他には例えば、
while (bytes_received < bytes_expected)
の方が、
while (bytes_expected > bytes_received)
よりも読みやすい。
左側(変化する値) | 右側(固定された比較対象) |
---|---|
調査対象・状況に応じて変わる値 | 基準値・あまり変わらない値 |
このようにすることで、可読性が上がるということ。ものすごく納得した。
if/else
ブロックの読みやすさを高めるコツ
次のようなルールが紹介されていた。
-
否定形より肯定形を使う。
if (!debug)
よりもif (debug)
の方がいい。 -
単純な条件は先に書く
-
目立つ・重要な条件を先に書く。条件分岐において、重要な判断材料は先に持ってくると意図が伝わりやすい。
ただし、これらはあくまで「原則」であって、状況に応じて自分で判断が必要とのこと。
おわりに
コードを書いていると、「この書き方で読みやすいのか?」と悩む場面がたまにあります。
迷ったらまたこの内容を読み返して、判断の軸として活用していこうと思います。