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

C# コンパイラは、コード中のドキュメント コメントを処理して XML ファイルを生成します。ドキュメントを作成するために XML ファイルを処理する詳細は、サイトに実装する必要があります。

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

Noteメモ :

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

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

<c>

<para>

<see>*

<code>

<param>*

<seealso>*

<example>

<paramref>

<summary>

<exception>*

<permission>*

<typeparam>*

<include>*

<remarks>

<typeparamref>

<list>

<returns>

<value>

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

ドキュメント コメントのテキストに山かっこ (<>) を表示する場合は、"&lt;" と "&gt;" を使用します。たとえば、"&lt;テキスト&gt;" のように記述します。

参照

処理手順

XML ドキュメントのサンプル

関連項目

/doc (ドキュメント コメントの処理) (C# コンパイラ オプション)

概念

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