メソッドのコメント
VS.NET&C#ではXMLスタイルのドキュメントをサポートしてます。
これの便利なTipsを紹介します。
メソッドが既にあるとします。その上の行で「///」と入力すると、VS.NETちゃんが雛形を勝手に作ってくれます。例えば「public int Skip(int celt)」というメソッドがあったときに、その上の行で「///」を入れると、
/// <summary> /// /// </summary> /// <param name="celt"></param> /// <returns></returns>
と勝手に書いてくれます。後は、メソッドの説明、パラメータの説明、戻り値の説明を書くだけです。楽ですねー。
便利な応用編。
.NETフレームワークからインターフェイスを継承したとき、MSDNを読みながらメソッドを書いていくことがよくあります。でもMSDNって遅いんですよね。さらにたいしたことが書いてなかったり、肝心のところは英語の別のページってこともよくあります。
こんなときにオススメなのが、上のコメント機能を使って雛形を作ったら、あとはMSDNからメソッドの説明、パラメータの説明、戻り値の説明をコピーしてしまいましょう。
何度もMSDNを参照しなくて済むので楽です!
/// <summary> /// Skip 列挙体シーケンス内の指定した数の項目をスキップします。 /// </summary> /// <param name="celt">列挙体内でスキップする要素の数。 </param> /// <returns>スキップした要素の数が celt パラメータに等しい場合は S_OK 。それ以外の場合は S_FALSE 。</returns>
(MSDNより引用)
こんな感じに。
ちょっとしたTipsでした。