【C#】XMLドキュメントコメント

クラスやメソッドのコメントは以前は

 

//---------------------------------------------------------------
//【関数名 】:Test
//【処理概要】:評価用の関数
//【引数  】:Para1        = パラメータ1
//      :Para2        = パラメータ2
//      :Para3        = パラメータ3
//【戻り値 】:エラー内容
//【備考  】:
//---------------------------------------------------------------
int Test(int Para1, float Para2, double Para3){

 

のような感じで書いていたのですが、.NET環境、特にC#においてはXML形式でコメントを書くことで、より応用が広がります。

 

と言っても、C#ではXMLの部分は自動で書いてくれるので、かなり便利です。

 

やり方は以下の通り。

 

まず、クラスやメソッド、フィールドのある程度の大枠(メソッドの場合は、少なくとも引数の部分)を書いておきます。

 


public int Test(int Para1, float Para2, double Para3)
{

    return 0;
}

 

次に、コメントを付けるクラスやメソッドなどのすぐ上の行で////を3個入力します。
すると、自動で以下のようなコメントが付いてくれます。

 

/// <summary>
///
/// </summary>
/// <param name="Para1"></param>
/// <param name="Para2"></param>
/// <param name="Para3"></param>
/// <returns></returns>
public int Test(int Para1, float Para2, double Para3)
{

    return 0;
}

 

<summary>はクラスやメソッドなどの概要
<param>は引数の説明
<returns>は戻り値の説明
を表します。
他にも使えるタグがあるので、詳細は下記msdnを参照下さい。
http://msdn.microsoft.com/ja-jp/library/5ast78ax

 

このタグに挟まれた部分にそれそれの説明を下記のように記載します。

 

/// <summary>
/// Testメソッドの概要
/// </summary>
/// <param name="Para1">Para1の説明</param>
/// <param name="Para2">Para2の説明</param>
/// <param name="Para3">Para3の説明</param>
/// <returns>戻り値の説明</returns>
public int Test(int Para1, float Para2, double Para3)
{

    return 0;
}

 

するとインテリセンスの表示の時に

 

 

のように、コメントに記載した部分がヒントで表示してくれます。

 

各引数の説明も、このように↓

 

 

表示しれくれます。

 

さらに、プロジェクトのプロパティでビルド→XMLドキュメントファイルの部分にチェックをいれ、XMLファイルを出力させる設定にすると、Sandcastleというようなヘルプファイル作成ソフトを使って、このXMLファイルを渡すとmsdnのようなヘルプファイルを作る事も可能になります。

 

他のVB.NETやC++/CLIでは、自動でXMLの部分を作ってくれないのですが、XMLの部分は同じ文法で書く事ができます。

 

やっぱC#ってすごい!



web拍手 by FC2

関連記事、スポンサーリンク

スポンサーリンク

カテゴリー: C#, プログラム  タグ: . Bookmark the permalink.

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です