<aside> 💡 コメントの目的は、書き手の意図を読み手に知らせることである

</aside>

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

コードからすぐにわかることはコメントに書かない!

また、ひどい命名はコメントを付けずに名前を変える

<aside> 💡 優れたコード > ひどいコード + 優れたコメント

</aside>

コードの欠陥にコメントをつける

コメント 役割
TODO: あとで手をつける
HACK: あまり綺麗じゃないコード
XXX: 危険!大きな問題がある
FIXME: 既知の不具合があるコード

定数にコメントをつける

定数にはなぜその値を持っているのか「背景」が存在する場合が多い

const NUM_THREADS = 8 // 値は「>= 2 * num_processors」で十分

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