コメントの量と質

プログラムのソースコードの中のコンピュータが命令で利用しない部分をコメントと言います。

また、空行やソースコードをツールで加工するための情報を、文法上のコメント行として記述する場合もあります。

不正確であったり誤解を招くようなコメントは、コメントがないより悪いということを肝に命ずべきである。

コメントはどのくらいで十分なのか？

コメントをどこに置くべきか？

コメントによって論理の流れを不明瞭にしていないか？

ソースを見る者を惑わすコメントになっていないか？

コメント自体が保守しづらいものになっていないか？

プログラムの補足情報として挿入するコメントは、命令語の部分と比べて、価値を低く評価する人がいます。

多くの組織ではコーディング規則の中にコメントに対する標準として記入する内容、含有率を定めています。

コメントの含有率が、コメントの量に関する指標の一つとなります。

また、組織によっては、詳細設計ドキュメントを作成せずに、プログラムのソースコードの中 に必要なコメントを埋め込むことにより、機械的に設計書を作成することもあります 。