/note/tech

コードのコメント、何をどう書けばよいのか:9つのベストプラクティスを紹介

↓の9つのルールが紹介されている

ルール1 コメントの内容はコードが表すものと重複してはならない

ルール2 良いコメントであっても、不明確なコードの言い訳にはならない

ルール3 明確なコメントが書けない場合は、コードに問題があるのかもしれない

ルール4 コメントは、混乱を招くのではなく、解消するものでなければならない

ルール5 慣用的でないコードはコメントで説明する

ルール6 コピーしたコードがあれば、元のソースへのリンクを張る

ルール7 最も役に立つ外部参照先へのリンクを含める

ルール8 バグ修正時にコメントを付ける

ルール9 コメントを使って不完全な実装に印を付ける