はじめに
今回は、第3章〜第4章を通して学んだことを整理します。
第1章〜第2章でのメッセージは、
「コードを理解するための時間を最大限に短縮させるために、クリアなイメージができる名前をつけろ」
だと思っていて、第3章では具体的な命名方法について書かれていました。
第4章ではコードの「レイアウト（視覚的な整列）」、
第5章ではコメントの書き方について書かれていました。
その中でも、特に今の自分にとって必要だと感じたポイントを整理します。
第3章での学び
-
limitのような曖昧な単語ではなく、maxやminを使って、範囲の意図を明確にする。 - 包含的／排他的な範囲を表すときは、
startやendよりも、beginやendを使う方が一般的。
第4章での学び
- 意味の近いコードは、縦に整列させることで一目で関係性がわかる。
第5章での学び
- コメントには、「自分の考えたこと」を残す。そうすることで、他の人が同じことを再び考える必要がなくなる。
- コードの欠陥にはコメントを付ける。
| 記法 | 意味 |
|---|---|
| TODO | 後で手を付けるべき箇所 |
| FIXME | 既知の不具合があるコード |
| HACK | あまりきれいじゃない解決策 |
| XXX | 危険！重大な問題がある箇所 |
- 定数が必要な背景や理由がわかりづらいときは、コメントを残す。
- プロジェクトにはじめて参加する人が疑問に思うであろうことをあらかじめコメントに残しておく。
終わりに
様々な方法論を学んだが、最も大切なことは
「コードを読む人の立場になること」
これに尽きるのではないかと思った。
そこには「想像力」と「工夫」が必要だと思う。
正直こういったことはちょっと手間だなと思ってしまうが、大切なことはだいたい面倒くさい。
だから、日々意識して習慣化させてしまおうと思う。