//コメントについて

オライリー社の「リーダブルコード」を読んでみた。5章:コメントすべきことを知る。6章:コメントは正確で簡潔に。なるほど・・・。

”まとめ”からコメントの目的とは、コードの意図を読み手に理解してもらうことである。

コメントすべきでは「ない」こと:

  • コードからすぐに抽出できること。
  • ひどいコード(例えば、ひどい名前の関数)を補う「補助的なコメント」。コメントを書くのではなくコードを修正する。

記録すべき自分の考え:

  • なぜコード型のやり方ではなくこうなっているのか(「監督コメンタリー」)。
  • コードの欠陥をTODO:やXXX:などの記号を使って示す。
  • 定数の値にまつわる「背景」。

読み手の立場になって考える:

  • コードを読んだ人が「えっ?」と思うところを予想してコメントをつける。
  • 平均的な読み手が驚くような動作は文章化しておく。
  • 読み手が細部にとらわれないように、コードブロックにコメントをつけて概要をまとめる。