<< トキソプラズマに感染すると洗脳される?? | Home | コピペできないエディタとか >>
PR: 転職    お墓    エコ    通販    結婚相談所    シルバー    質屋    葬式    漫画    エステサロン   

「変数を宣言する」というコメント

    //変数を宣言する
    int rst = 0;

なんか、こういう書いちゃいけないお手本のようなのが見つかるとあきれるを通り越して感動すら覚えるのだけど、結局こういうのはコーディング規約の副作用というものなのだろうな。「コメント比率xx%以上」みたいな機械的なルールを作れば、こういう百害あって一利なしのコメントが増殖する。「総行数、xx以下」みたいなルールを作れば、?演算子でやたらめったら一行に押し込んだ条件文が氾濫する。ルールを作った側は、良いコメントが増えるだろうとか、メソッドやクラスの分割が進むだろうとか期待するんだろうけど、どうも自分の経験上、実際のところはそういう方向には99%行かない事が分かってきた。



Re: 「変数を宣言する」というコメント

コメントの記述自体を禁止するのが一番かと、そうすると読みにくいコードを書いて一番ダメージを受けるのは本人なので。

Re: 「変数を宣言する」というコメント

コメントが必要なケースもあるので、禁止ではなくガイドくらいが良いかと。

読みにくいコードを書いて、書いた本人がダメージ受けるんならいいんですけど、実際は書き逃げプロジェクトが多いように思います。書いた本人が保守フェーズやるケースなんて、昔、自分がやっていた組み込み系くらいでしか見たこと無いし。大抵はテストフェーズの段階で、既にいなくなっているケースが大半では無いですか?

んで、書く手間の2-3倍くらいの手間かけて直していたりして。でも数字上はコード部分のコストが減って、上の方は喜んでたりして。悲しいかな、どこもそんな感じに見えます。

Re: 「変数を宣言する」というコメント

これらはローカル変数です、とかグローバル変数です、とか一言書いて宣言した10数年前が懐かしい。。。いまはコメント書かないんですか? (って言ってる時点でダメ?)

Re: 「変数を宣言する」というコメント

少なくともC/C++あたりであれば、ローカル変数かグローバル変数かは、文脈で決定される思うので、コメントとしては、冗長だと思います。書かなくても自明だから。
今時の言語は、昔コメントで表現していた事の大半を、別の方法で表現できるので(分かりやすい変数名をつけるとか、意味補強のためだけにメソッドに切り出すとか)、必要がある時以外はコメントは書かないようにした方が良いと思います。が、それが世間の常識になったかというと、まだまだです。

コメント追加 トラックバック送信
このサイトの掲載内容は私自身の見解であり、必ずしもIBMの立場、戦略、意見を代表するものではありません。
日本アイ・ビー・エム 花井 志生 Since 1997.6.8