ドキュメント コメント用の推奨タグ (C# プログラミング ガイド)

  • [アーティクル]

コード内のドキュメント コメントは、C# コンパイラによって処理され、/doc コマンド ライン オプションで指定した名前のファイルに XML 形式で出力されます。 コンパイラによって生成されたファイルに基づいて最終的なドキュメントを作成するには、カスタム ツールを作成するか、ツールを Sandcastle使用します。

タグは、型や型メンバーなどのコードの構成体に対して処理されます。

注意

ドキュメント コメントは、名前空間に適用できません。

C# コンパイラは、有効な XML のタグをすべて処理します。 ユーザー ドキュメントで一般的に使用される機能を提供するタグを次の表に示します。

タグ

<c>

<para>

<see>*

<code>

<param>*

<seealso>*

<example>

<paramref>

<summary>

<exception>*

<permission>*

<typeparam>*

<include>*

<remarks>

<typeparamref>

<list>

<returns>

<value>

(* は、コンパイラが構文を検証することを示します)

ドキュメント コメントのテキストに山かっこを表示する場合は、次の例に示すように &lt; と &gt; を使用します。

/// <summary cref="C &lt; T &gt;">
/// </summary>

参照

関連項目

/doc (C# コンパイラ オプション)

XML ドキュメント コメント (C# プログラミング ガイド)

概念

C# プログラミング ガイド