長いので章ごとにしてます。
11 コメント ー保守と変更の正確性を高める書き方ー
- コメントはなるべく書かないようにしてます。読んでわからないようなことを書かないようにしてるつもりで…。
- TODO、FIXMEとかそういうのがほとんど…のはずです。
11.1 退化コメント
- コメントはテストされないですからねぇ…。
11.1.1 コメントは劣化コピーに過ぎないことを理解すること
- ああ、意志そのものじゃないからですか…。なるほどです。
11.1.2 ロジックの挙動をなぞるだけのコメントは退化しやすい
- 流し読みしようとしたときに読みやすいメリットはあるけど、時間経過に弱いですよね。
11.2 コメントで命名をごまかす
- リスト11.3 …こんなメソッド名つけます？？？
- リスト11.4 …わざわざこんなコメントつけます？？？
- リスト11.5 …このコメント、再説明じゃないけどいらないような…？
11.3 意図や仕様変更時の注意点を読み手に伝えること
- リスト11.6 … 十分わかりやすいメソッド名だし、コメントいらないんじゃ…？
11.4 コメントのルール まとめ
- 明文化しておくのは悪くなさそうです。新規参入したひとに読んでねって渡せますもんね。
