昨年度末の姫路IT系勉強会で発表した私のネタがこちら 『プログラミング時のコメントについて』 内容は、プログラミング時のコメントってどうやってます？という 質問だったのですが、少し まとめてみました。
※当日のログについては、下記のGoogle Documentをご参照くだしあ。
もともと、自分のやっているC#やVB.NETでは、 VisualStudioでXML形式のコメントが自動生成されるので、 メソッドやクラス、プロパティ、フィールドなどについては、 コメントが非常に入れやすくなっています。
名前や説明、引数、戻り値、例外などの必要最低限の情報が 記入できるようになっています。
また、インテリセンスの機能で、設定した名前などを見ることができるので、 もともと便利な機能でよくコメントを設定していたのですが、 古いソースをみていると、それがほとんどない…
「普段の開発で、どの程度のコメントを入れるのかな？」
と気になって聞いたのですが、
- 外から見える奴（C#やVB.NETなどはPrivate以外） は絶対書く
- 変数名、引数名も絶対書く
- とりあえずリーダブルコード読め
という意見を頂きました。
ちなみに、自分は以下のようにコメントを書いてます。
大体、コンストラクタ、メソッド、イベント、プロパティ、フィールドなど、 クラス内で宣言しているものには必ず処理名や変数名を入れるようにしています。
（メソッド内で宣言しているローカル変数は、あまり入れてません）
また、何かを渡したり、返す場合には、やのコメントを付けるようにしています。
メソッド内などの処理でコメントを入れるのは、 だいたい、TODOコメントを入れる程度です。
次に、読みやすいコードを書けば、 そもそも処理中にコメントは不要じゃない?という思いもあります。
（Paint処理でg.FillRectangleなどの処理を延々と書くような わけわかめになりやすい処理なら重要なポイントのみ書くかもしれませんが…
基本的には、あまりコメントを入れなくても分かるような名前付けを意識しています） なかなか、自分のスタイルによって意見の分かれやすい気がする部分ではありますが、 今後、コード規約（自分用）としてまとめたいなぁと考えています。