冗長性の排除

コメントとして価値のあることだけを書きましょう。コメントがあるとその分だけ読むのに時間がかかるため、価値のないものは消すべきです。

価値のないコメントとは以下のようなものです。

• 名前、引数、戻り値など、宣言からわかること
• 実装者のためのコメントの場合、コードを読めばすぐにわかること
  • 理解するのに時間がかかりそうな場合はコメントすべきです

NOTE

価値のないコメントを書かない

バージョン管理

「今は使わないけど一度書いたコードを消すのはもったいないからコメントアウトしておく」というのはNGです。Gitのようなバージョン管理システムを使いましょう。コミットされているコードは、削除して別のコミットをしてもすぐに戻せます。コミットしていないコードは別のブランチでコミットするか、stash によって残せます。コメントアウトするのであれば消しましょう。