小野和俊のブログ:ソースコードのコメント率は20%を切ることが望ましい

大学の研究室の教官は昔NTT研究所の所長をされていた苗村先生という人で(と言いつつ私は大学の研究室にほとんど顔を出していなかったのだけれど)、彼の発言のうち印象に残っているものの一つとして、昔はソースコードのコメント率が50%を切るものはドキュメント不足で品質が低いものとされた、という内容のものがあった。 今、改めて考えて、どのような言語であってもどのようなコーディング規約であっても、私はソースコードのコメント率は原則20%を切ることが望ましいと思う。可読性の意味でもメンテナビリティの意味でも、開発生産性の意味でも。私が考えるに、本来コンピュータが読むためのものであるソースコードに人が読むためのコメントを付け加えなければならないのは、次の２通りの場合だけである。 1.公開されるAPI APIやソースコードそのものが公開される場合、利用者は不特定多数となり、利用者のスキルにもばらつきが出て、

[yhakusyaku]

コメント量については議論があると思うけど、コメントがなくてもわかる実装が望ましいと思う。：小野和俊のブログ:ソースコードのコメント率は20%を切ることが望ましい

[joan9]

ハッカーと画家で「コメントは急カーブ注意の標識のようなもの」というような話があったような気がするけど、ぼくもそう思う。本文中にもあるように事情がある場合以外はコメントなしで理解できるコードにすべきかと

[mura-taiken]

コンピュータが理解できない記述は最小限にするべき。そして、平文との差が小さいコードを書けば良い。

[Nagise]

外部公開部分→javadocを使用。トリッキーな実装というより「コードの意図」を書いておくと捉えた方がいい。ソースコードはどう動くかという事実を雄弁に語るが、どういう意図で書かれたかには寡黙だ。

[hamasta]

ソースのコメント設計書は別だし、コメント率の多寡なんて全く関係ないと思う.

[jukuringo]

５０%ってすでに設計書を書きましょうれべる？

[webmarksjp]

development

[kanbayashi]

興味深い

[ymorimo]

APIドキュメンテーション != コメント

[chuli]

果てしなく同意！！！！！

[hiragisan]

コードで語ることができる人同士では通じるんだろうが…

[kkobayashi]

%云々ではないわな。必要最小限。

[odz]

コメントはAPIドキュメント＋トリッキーなコードの説明のみに絞る

[Trapezoid]

見ればすぐに分かることは書かなくても良いということ。意外と出来てない人が多い。

[denken]

たしかに

[xondhi]

とはいっても、Javadocコメントなんかつけてるとコメント多くなるんだよなぁ。

[todesking]

何がひどいって、世の中には「ソースコードのコメント率は50%以上がふさわしい」と考えている人間が存在することが。そしてこんな常識的な話に大量ブクマが…… リファクタリング本くらい読めと。

[fuki1234]

何をトリッキーとするかが人によって違うから粒度が変わってくる。ソースが仕様書だ！

[t-wada]

"本来コンピュータが読むためのものであるソースコードに人が読むためのコメントを付け加えなければならないのは、次の２通りの場合だけ。1.公開されるAPI。2.トリッキーな実装"

[suVene]

メソッドの中のコメントはなるべくなくして簡潔に記述するのが好きだが、外部I/Fの説明はきっちり書いておいたほうがいいと思うな。

[koutaki]

おお、先輩だったのか

[hujikojp]

うらやましい。

[hiro_y]

ソースのコメント率、必要な場合/不要な場合。

[j0hn]

クヌースの文芸的プログラミングの理念が入っているのでは? → 50%

[fbis]

ソースにコメントなどいらぬ！といいつつコメントを書く。あ、ドキュメントは別カウントだよね。