コメント!=ドキュメント : 404 Blog Not Found

2006年09月04日15:15 カテゴリLightweight Languages書評/画評/品評 コメント!=ドキュメント なぜコメントの付け方の昔と今が違うかと言えば、原因は二つある。 Perl Best Practices Damian Conway [邦訳:Perlベストプラクティス] 小野和俊のブログ:ソースコードのコメント率は20%を切ることが望ましい 昔はソースコードのコメント率が50%を切るものはドキュメント不足で品質が低いものとされた、という内容のものがあった。 [中略] 今、改めて考えて、どのような言語であってもどのようなコーディング規約であっても、私はソースコードのコメント率は原則20%を切ることが望ましいと思う。 まずは言語仕様そのもの。昔は変数名の長さに限りが合ったり、loop controlにifとgotoしか使えなかったりで、「プログラムそのものに語らせる」

[katow]

なるほど。

[fuktommy]

僕の周辺だとコメントといえばJavadocの類のことで、ドキュメントというとWikiページのことだなあ。

[webmarksjp]

*programming

[harumomo2006]

コメントがあればドキュメントなんていらないとか言ってるボケに見せる

[Tskk]

昔と今では必要なコメントの量が違う。今の言語はコードが饒舌なのでコメント不要。

[hiroakiuno]

codeそのものが饒舌になった今、それこそコメントは「蛇足」というものだろう。あなたが迷ったり勘違いしたところをコメントせよ。一般読者には取説を用意するべきなのだ。

[xondhi]

「あなたが迷ったり勘違いしたところをコメントせよ」これは名言だねぇ。

[seamlessbias]

コメントあんまり書いてないや。コメントに依存してるコードは好きじゃないし。

[mowamowa]

「codeが饒舌になったのだから、コメントの役割も変わる」

[fbis]

ある時期を境にコメントをあまり書かなくなったなぁ。それに引き換えドキュメントはいつもソースより多くなるｗ

[hiro_y]

「codeそのものが饒舌になった今、それこそコメントは『蛇足』」

[kazeburo]

。実際私はほとんどコメントを書かない。書いたら負けとすら思っている。

[vkgtaro]

「codeそのものが饒舌になった今、それこそコメントは「蛇足」というものだろう。」