コメントには意図（why）を書こう

アジャイルプラクティス 達人プログラマに学ぶ現場開発者の習慣

“アジャイルプラクティス”という本を読んで、「これはいい考え！」と思った内容があったので、メモ。
「コメントには、なぜその意図を（why）書こう。そのコードが何をしているか（what）ではなく。」

コメントって、いつも書きながら「どこまで書くべきか」についてすっきりしない感じがあったんだけど、「内容ではなく意図を書く」っていうのは正解かも。「意図（why）」っていうのは、コメント以外では伝わりづらいと思うし、逆に、「内容（what）」って言うのはメソッド名とか、変数名とかである程度表現できるので。
それに、処理の内容までコメントに書いたときって、後で読み直してみると「わざわざ書くまでもないなあ」ってことも多いし。

なので、

1. なぜそのメソッド（あるいはコード）があるか
2. 類似のメソッドとの違い（使い分け）
3. その他、前提条件などの注意事項

についてのみコメントを書く、というのを実践してみようっと。