補足の排除

コメントで補足する前に、コードをわかりやすく修正しましょう。基本的に理解しやすいコードを書いていればコメントでの補足は不要です。コードは再利用されるため、理解しにくいコードに優れたコメントをつけるよりも、優れたコードを書くほうが大切です。

NOTE

コメントで補足するのではなく、コードを理解しやすくする

注意

最適化等でどうしても理解しにくいコードにせざるを得ない場面や、ある情報に特に注意させたい場面もあります。その場合はコメントで補足しましょう。