コードにコメントを書かない事を責められた時の言い訳

2007/1/29

プログラミングにおいて、コード中にコメントを残す事は非常に重要です。 たとえ自分で書いたコードであっても、1ヶ月もすれば詳細は忘れてしまい、他人が書いたものと変わらなくなってしまいます。

しかし、その重要性とは裏腹に、コメントが書かれていないコードというのも非常に多く存在します。 私もついついサボってしまう事があります。

今回は、プログラマがコメントを書かない理由や言い訳を考えてみました。 項目には実際に聞いた事がある言い訳と、脳内妄想が混ざっています。 しかし、一応、全部フィクションということにしておいてください。

1. 面倒だから
2. 時間が無い
3. 動けばいい
4. 仕様は仕様書に書いてある
5. 設計は設計書に書いてある
6. 内容が知りたければ聞きに来い
7. その部分は、また後で変更されるだろうからコメント書いても無駄
8. このコードは明日以降は二度と触らない予定だから
9. 俺以外はその部分を触らない
10. どうせ書いても誰も読まない
11. そこを書いていた奴は転職しちゃったから、理解していてコメント書ける人はいなくなった
12. 日本語を入力する環境が無いけど、英語で書くのは面倒だから
13. どうせプリプロセッサが取り除く部分だ
14. 何でコメントを書かなかったのかを既に忘れてしまった
15. いやぁ、コメント書くのは重要だよね。。。。いや、重要だよね。でもねぇ。
16. 代わりに書いてくれると凄く嬉しい
17. コメントを書かなくても評価には影響しない
18. コードが語っている

プロフェッショナルIPv6解説動画シリーズ再生リスト

動画で学ぶ「プロフェッショナルIPv6」を作っています。 もしよろしければご覧ください。お楽しみいただければ幸いです!