IT用語集 › プログラミング › コメント
コード中に書かれた、コンパイラやインタプリタには無視される人間向けの文章。
どこまで書けば「多すぎ」なのかは、昔から続く論争である。定石は「何をしているか」ではなく「なぜそうしたか」を書くこと(何をしているかはコードが語る)。JSDocやdocstringのようなドキュメントコメントからはドキュメントを自動生成できる。典型的なアンチパターンは、コードの現状と食い違ったまま放置され、嘘をつき続ける古いコメントだ。