 コメントがない
深刻度：★（軽度）
[症状]
プログラムコードにコメントが書かれていないものです。どういうプログラムなのかをコードを追いかけて調べるのに手間がかかり，開発に遅れを生じさせます。 [原因]
おそらくめんどうだったか，開発者が「わざわざコメントにするほどでもない」と思ったのでしょう。怠慢というやつです。 [対策/予防]
これに関してはコメント付けを習慣づける何らかのシステム作りをすべきです。 [例外]
別途，プログラムの説明やコメント代わりの情報を記述した文書があるなら，プログラムソース中にコメントがなくてもかまわない場合があります。また，なんでもかんでもコメントを付ければいいというわけでもなく，冗長なコメントや意味不明なコメントがあると，かえってプログラムの解読者をミスリードしかねません。 [備考]
案外，深刻度が「軽い」のに驚いた人もいるでしょうが，実はコメントがあったとしても，その品質に問題がある場合，そっちのほうが有害な場合が多いのです。そういう意味で深刻そうな禁じ手パターンは，次に紹介する「コメントに嘘がある」です。
コメントに嘘がある
深刻度：★★（中程度）
[症状]
コメントに書かれていることと，実際のコードの内容が一致しないパターンです。コメントに書かれている嘘の内容を信じてコードに間違った改変をほどこしたり，その結果，別の障害が出て，開発に遅れを生じさせることになります。 [原因]
これもコメントを書いた責任者の怠慢や注意力の不足が最大の原因です。 [対策/予防]
これに関してもコメントの品質を保証するためのシステム作りをすべきですし，原因となった者の責任を問えるシステム作りをすべきでしょう。 [例外]
このパターンに関しては例外を認めるとたいへんなことになります。例外を認めるということは，すなわち怠慢を積極的に認めることになるわけですから，絶対にありえません。
コメントが意味不明
深刻度：★（軽度）
[症状]
コメントの内容が理解できない内容になっている場合，あるいは「○○ちゃーん，愛してるよー」のようなプログラムの内容と全然関係のない落書きが書かれているパターンです。 [原因]
本人の国語力不足，あるいはユーモアがあると思い込んでいるのか人格的に問題がある場合です。 [対策/予防]
これもコメントの品質の評価，罰則規定などのシステム作りをすべきでしょう。とくに本人がユーモアのつもりだったり，たんなる茶目っけのつもりでふざけたコメントを付けた場合，真剣にコメントを読んでいる人たちを怒らせたり，あるいはチームの志気を落とす危険性があります。 [例外]
チームで開発している場合，例外を認めるとたいへんなことになります。しかし個人が趣味でやっている場合はかまわないかもしれません。とはいっても，昔書き込んだ自分のふざけたコメントを読んで腹をたてることもありうると思います。 [備考]
嘘はないにしても何を説明したいのか意味不明のコメントはほかの開発者を混乱させてしまします。コメントの解釈に時間を取られるので開発に遅れを生じさせることになります。また，昔気質のプログラマに多いのですがコメントを英語(もしくは本人が英語と思いこんでいるだけのデタラメの言葉)で書くというパターンもこれに準ずるので，紹介しておきましょう。
コメントが英語
深刻度：★（軽度）
[症状]
コメントが英語，あるいは英語モドキになっているパターンです。わからない単語を辞書で調べるのも手間だし，モドキの場合は意味不明のコメントとなっていて役に立たないこともあります。場合によっては喧嘩やトラブルの原因にもなります。 [原因]
本人の勘違い(英語で書いたらカッコいい。これからは国際化時代でグローバルスタンダードだもんね。みたいな)，外国人も開発に参加している，英語でしかコメントを受け付けない開発環境などの原因が考えられます。 [対策/予防]
本人の勘違いの場合は，それを本人にわからせることが重要ですが，現時点でこういう英語コメントのスタイルを貫くというのはたいてい確信犯的というか，一種の変人でもあります。なるべくかかわらないようにするか，黙認するしかないでしょう。外国人が参加しているプロジェクトの場合や環境そのものが英語しか受け付けない場合はやむをえないかもしれません。 [例外]
外国人も参加しているプロジェクトで，そのメンバからコメントを英語にしてほしいという強い要求があるならやむをえないかもしれません。しかし，そういう場合でも日本語のコメントと英語のコメントを併記するという工夫がほしいところです。環境が英語しか認めない場合でも，よく調べると単にフォント指定を日本語にするのを忘れていたとかつまらない理由がありがちです。ちなみに筆者がMacintoshで使っている開発環境は，デフォルトの設定が英語になっている場合が多いので最初にフォント指定を日本語に変更することから始めます。いわゆる1バイト=1文字の決めつけで動いている開発環境でもコメントは多バイト文字が使用できるケースが多いのです。とにかく簡単にあきらめずに調べつくしましょう。 [備考]
英語コメント(あるいは英語モドキコメント)に関してはパソコン通信やインターネットでバトル(あるテーマに関する論争)になるぐらい危険な話題です。ちなみに筆者もこの種のバトルに参加したことがありますが，いまの時点であえて英語コメント(あるいは英語モドキコメント)をする人は一種の妙な信念に凝り固まっているようで，これを説得するのは難しいと感じました。外国人が関わったらという大義名分もありますが，実際に日本で仕事をしているかぎりでは滅多に外国人といっしょに仕事をする機会はないですし，だいいち目の前にいる日本人の同僚とうまくコミュニケートできない人が海外の方とコミュニケートできるものかどうか，とても疑問なんですけどね。ついでにいうと，昔，筆者は韓国の会社と仕事をしたことはありますが，そのときのプログラムのコメントは韓国語になってました。しかし，そのことがとくに仕事で支障になった記憶はありません。要するに「何語でコメントを付けるか」ではなく「どういう運営をするか」が大事なわけです。
| 