スケルトンの生成

XMLドキュメントコメントは、手で入力することもできますが、スケルトン(ひな形)を利用したほうが楽に書けます。スケルトンを生成するには、対象コードの1行上に「///(VBでは''')」と入力します。 例えば、CalcというクラスのXMLドキュメントコメントを書く場合「public class Calc{」の一行上で「///」と入力すると、次のスケルトンが生成されます。

クラス用に生成されたスケルトン


/// <summary>
/// 
/// </summary>
public class Calc{
...省略...

メソッドやプロパティ等の場合も同様で、メンバを宣言しているコードの1行上で「///」と入力すると、その宣言に応じたスケルトンが生成されます。

Addメソッド用に生成されたスケルトン


/// <summary>
/// 
/// </summary>
/// <param name="x"></param>
/// <param name="y"></param>
/// <returns></returns>
public int Add(int x, int y){
    return x + y;
}

このメソッドでは、xとyいう引数と戻り値が存在するため、<param name="x">や<param name="y">や<returns>といったタグが自動的に生成されています。もし、メソッドの定義とタグの定義が一致しない場合には、コンパイル時に警告が発生しますので、その場合はXMLドキュメントコメントを修正するようにしてください。

XMLドキュメントコメントの詳細

XMLドキュメントには、本稿で紹介した以外のタグも利用することができます。詳細については、MSDNのページを参考にしてください。なお、このMSDNの推奨タグのページに書かれているように、名前空間には、対応するXMLドキュメントコメントが存在しないことに注意してください(ただし、後述するSandcastle Help File Builderでは名前空間の説明を追加する機能があります)。