種類

コメントはその対象読者によって2種類に分けられます。

実装者のためのコメント

• なぜそのように実装しているのか(WHY)

使用者のためのコメント

• 何をするクラス・関数なのか(WHAT)
• どうやって使うのか(HOW)

読者を意識してコメントを書きましょう。

NOTE

コメントは誰のために書くのか意識する