[jfriends] Re: [jfriends] Re: コメント

[Kazuya Maebashi <PXU00211@xxxxxxxxxx>]

前橋です。

Shin さん:
>// 20回ループ
>for (int i = 0; i < 20; i++) {
>
>みたいな
>
>あ、でも私の場合、日本語の方が目立って見えるので
>>int userId;  // ユーザID
>でもないよりましかもしれません.

確かに、日本語の方が目立つというのは割と重要だったりするんですけど、
「ないよりまし」レベルのメリットしかないのなら、コメントが間違って
いた場合の危険性と、コメントを入れる手間を秤にかけたら、得とは言い
がたいのではないかと。

えんどうさんの好きなMindみたいに、変数名に日本語が使えていたら、
またちょっと違う展開になっていたかもしれません。

でも、所詮、「抽象度」がソースと変わらないコメントにはそれほど
意味はないわけで...

シロートさんに、彼の書いたコーディングについて質問したりするとですね、

「で、ここは結局何をやりたいの?」

「だからあ、変数hogeに○○を代入してえ」

「そんなことは見ればわかるの。で、結局何をやりたいの?」

「???」(きょとんとしている)

経験ありませんか?

こういう人を、「コメントいっぱい書け」とどやしつけたところで、
出てくるものは、「ユーザID」が関の山なのでは...


>もう一言、
>// 〜するために使用するユーザID
>ならいいんですよねえ.

そう思います。

>私の一番腹が立ったのは、
>/*** 1997/mm/nn rel.xx だれそれ add start **/
>	:
>/*** 1997/mm/nn rel.xx だれそれ add end **/
>ってやつでした.
>あんた問い合わせればなぜ追加したか教えてくれるの?って感じ.

いえいえ、この手のコメントは、一度関わったら最後決して抜けられない、
ブラックホールのようなプロジェクトでは、結構役に立ちますよ。
会社を辞めでもしない限り、人を絶対に動かせないプロジェクトなら、
問い合わせれば教えてくれる可能性もあります(そういう問題か?)。

>JavaDocに関して言えば、@xxxxxxxxxx等のタグを自動生成してほしいですね.
>その用法部分だけ書けばすむように.(もちろんthrows等も)
>この辺もIDE付属エディタならサポートしていそうな気はしますけど.

コメントを、コンパイラが無視するからいけないわけで、
Pythonのdocument string(でしたっけ?)みたいに、構文規則に組み込
んでしまえば良いと思うんですけどね。

どんなもんでしょう?

                                                      de 前橋