ドキュメントXML
最終更新：
maenotti_10 2010年11月22日(月) 12:56:57履歴
ドキュメント コメント用の推奨タグ (C# プログラミング ガイド) 
| <c> | テキストをコードとして指定 | <c>text</c> | text:コードとして指定するテキスト。 |
| <code> | 複数行をコードとして指定 | <code>content</code> | content:コードとして指定するテキスト。 |
| <example> | メソッドやその他のライブラリ メンバの使用例を指定 | <example>description</example> | description:サンプル コードの説明。 |
| <exception>* | メソッドやその他のライブラリ メンバの使用例を指定 | <example>description</example> | description:サンプル コードの説明。 |
| <include>* | メソッドやその他のライブラリ メンバの使用例を指定 | <include file=filename path='tagpath[@name="id"]' /> | filename:ドキュメントを含むファイルの名前。ファイル名にパスを指定することもできます。 |
| filename は、単一引用符 (' ') で囲みます。 | |||
| tagpath:filename のタグのパス。その後ろにタグの name を指定します。パスは、単一引用符 (' ') で囲みます。 | |||
| name:タグの名前指定子。その後ろにコメントを指定します。name には id を指定します。 | |||
| id:タグの ID。その後ろにコメントを指定します。ID は、二重引用符 (" ") で囲みます。 | |||
| <list> | 表または定義リストの見出し行の定義に使用 | term:定義する用語。定義は、description に記述されます。 | |
| description:箇条書きリストまたは番号付きリストの項目、あるいは term の定義のいずれか。 | |||
| <para> | 段落 | <para>content</para> | content:段落のテキスト。 |
| <param>* | パラメータの 1 つを説明 | <param name='name'>description</param> | name:メソッド パラメータの名前。名前は、二重引用符 (" ") で囲みます。 |
| description:パラメータの説明。 | |||
| <paramref>* | 参照として指定 | <paramref name="name"/> | name:参照するパラメータの名前。名前は、二重引用符 (" ") で囲みます。 |
| <permission>* | メンバへのアクセスをドキュメント | <permission cref="member">description</permission> | cref = "member":現在のコンパイル環境からの呼び出しに利用できる、メンバまたはフィールドへの参照。コンパイラは、指定されたコード要素が存在することを確認してから、member を出力先 XML 内で標準要素名に変換します。member は二重引用符 (" ") で囲みます。 |
| ジェネリック型への cref 参照の作成方法については、「<see> (C# プログラミング ガイド)」を参照してください。 | |||
| description:メンバへのアクセスの説明 | |||
| <remarks>* | 情報を補足 | <remarks>description</remarks> | Description:メンバの説明。 |
| <remarks>* | 戻り値を説明 | <returns>description</returns> | description:戻り値の説明。 |
| <see>* | テキスト内でリンクを指定 | <see cref="member"/> | cref = "member":メンバまたはフィールドへの参照。 |
| <seealso>* | 「参照」のセクションに示すテキストを指定 | <see cref="member"/> | cref = "member":メンバまたはフィールドへの参照。 |
| <summary>* | 説明に使用 | <summary>description</summary> | description:オブジェクトの要約。 |
| <typeparam>* | ジェネリック メソッド | <typeparam name="name">description</typeparam> | name:型パラメータの名前です。 |
| description:型パラメータの説明です。 | |||
| <typeparamref >* | ジェネリック メソッド | <typeparamref name="name"/> | name:型パラメータの名前です。 |
| <value>* | 値の説明 | <value>property-description</value> | property-description:プロパティの説明。 |
ドキュメント コメントのテキストに山かっこ (<>) を表示する場合は、"<" と ">" を使用します。たとえば、"<テキスト>" のように記述します。
ドキュメント コメント用の推奨タグ (C# プログラミング ガイド)より作成。
タグ
コメントをかく