コメントの目的は・・・

小野和俊のブログ:ソースコードのコメント率は20%を切ることが望ましい
http://blog.livedoor.jp/lalha/archives/50126803.html

基本的には小野さんの考え方は非常に同意だけれどプロジェクトによっては必ずしもそれが良いこととは思えない。

プロジェクトによって仕様書の内容も違えばソースコードを読む人のレベルも保守の体制も違う。
それぞれの状況に応じて書く内容は違って当然な気がする。

目的は「誰に」対して「何を」「どのように」伝えるか、だと思うので、プロジェクトによってはコメントの目的が変わっても良いかなーと思う。

ちょうどXP祭りでの角谷さんが

ソースコードがHow(どのように)、テストコードがWhat(何を)、ドキュメントにWhy(なぜ)

※たぶんこんな感じなだったと思う(コメントじゃないけど)

な事を発言して「おぉー」っと思ったけどこれも同様かな。

以前プログラムのコメントに関してエントリーした事があり、コメント欄での議論がいい感じになったのでご紹介。
せつないぶろぐ : プログラムのコメントについて

コメントについての具体的な記事はこちらが参考になります。
職業としてのプログラミング 省コメントのススメ

2件のコメント

  1. はい、概ね同じです。フレームワークやライブラリのpublished APIについては、プロダクトコードにもコメントはあったほうが良いと思いますこれは自分にも反省すべ点が多い)。

  2. かくたにさん
    コメントありがとうございます。
    固執しすぎるのは問題ですね。
    そのプロジェクトに合った方法で目的に向かいたいですね。
    Reloaded期待していますw

コメントを残す

メールアドレスが公開されることはありません。