WebKit ソースコードのコメント議論(1)

WebKit 開発者のメーリングリスト webkit-dev を見ていたら、興味深い話題で盛り上がっていた。WebKit のソースコードや ChangeLog のコメントに関する議論だ。 WebKit に限らず、ハッカーというのはソースコードにコメントを書きたがらない。 コメントが古くなってしまい、実情と合わなくなってしまうから、というのが理由としてはよく聞かれる。すぐ古くなってしまうコメントを書くより、元々コメントを書かなくて済むような綺麗なコードを書けよ、とハッカー達はよく言う。 個人的には、コードでは処理の内容は記述できるけれど、意図を記述できないので、意図を補足するコメントぐらいは必要なんじゃないか、と思っているけれども、それすらダメと言う人も時々見かける。 ともかく、今回の議論は自分にとっては興味深かった。 そこでその内容を紹介してみようと思う。 議論はいくつかのトピックに分かれ

[nakag0711]

「コメントを書かなくて済むような綺麗なコード」そう思っているのはコードを書いた本人だけ

[roshi]

インセンティブとかコメントが古くなるとか理由が謎すぎる。。分かりやすい名前をつける、コメントが間違ってたら直すまでを含めて”コーディング”だと思うけどなー。

[akabekobeko]

xDoc 系ツールで API リファレンス生成されることを想定しインターフェースに対して書く。意図や目的について書いているならコード変更の影響は受けないし意図や目的が変わったならコメントも修正すべきという考え。

[t-wada]

API ドキュメントと CHANGELOG 、テストコードはもちろん書くとして、コード内には「あえてやっていること/やっていないこと」だけをコメントに書くのが良いと考えています

[rti7743]

changelogってcommit logとか元に自動生成できないもんかな。みんな大好きV8エンジンのchangelogなんて Performance and stability improvements on all platforms. しか書いてなくて面白いぞ。 https://github.com/v8/v8/blob/master/ChangeLog

[tbpg]

"コメントが間違っていてもコンパイラはチェックしないから、誰も直そうというモチベーションにならない"

[Horiuchi_H]

コメント議論については、結局堂々巡りだな。自分も基本的にコメントは書かなくなった。

[Haaaa_N]

webkitはまず膨大なコードの量をどうにか減らせないんですかね 外部ライブラリ化するとか

[adwd118]

なるべく書かないけどコードに表せないこと（実装の意図とか）はちゃんと書く感じなのかな

[gfx]

どこも同じだな…。

[clngn]

“「コメントは書くべきでない」という文化があることで、それがプレッシャーになって、クラス名について一生懸命考える。それによって、良くない設計に気付いて見直したりすることもある。”