C#のXMLドキュメントコメント記述の際に使用されるタグの一覧
| タグ名 | 内容 |
|---|---|
| summary | 型また型のメンバの概要 |
| remarks | 追記(追加情報) |
| value | プロパティ値説明 |
| para | 記タグ内で段落作成が可能 summary・remarks・returns |
| param | メソッドパラメータ、型自動判定 |
| typeparam | ジェネリック型1パラメータ、型自動判定 |
| paramref | インラインのパラメータ参照 |
| typeparamref | ジェネリック型1パラメータ参照 |
| returns | 戻り値 |
| exception | 例外 |
タグの記述方法
/// <summary>概要の説明</summary>
/// <remarks>備考</remarks>
/// <value>プロパティ値説明</value>
/// <para>段落テキスト</para>
/// <param name="メソッド パラメータ名">パラメータの説明</param>
/// <paramref name="参照パラメータ名" />
/// <typeparam name="型パラメータ名>型パラメータの説明</typeparam>
/// <typeparamref name="参照パラメータ名" />
/// <returns>戻り値の説明</returns>
/// <exception cref="member">例外説明</>