【プログラミング】美しいコメントの書き方

質問

【プログラミング】美しいコメントの書き方

VBSでプログラムを作っています。

後で読み返したときに、他の人でも読めるように、
美しくというか、わかりやすい
コメントの書き方を教えてください。

回答No.1

taka451213 · ベストアンサー

こんにちは。

コメントは「何をしているか？」ではなく、「何のためにしているか？」を書くべきだそうです・・・。
何をしているのかは、ソースを見ればわかるという事ですね。
かくいう私は、コメント書かない派ですが・・・。
理由は、プログラムをメンテしても、コメントを放置するパターンが多くて、結局意味がないどころか、かえって邪魔になるからです。

回答No.2

noname#140925

以下はJavaの例ですが、以下のようにファンクション毎に機能説明や引数、戻り値書いておけば良いです。

[参考]Javadoc - Wikipedia
http://ja.wikipedia.org/wiki/Javadoc