ドキュメント コメント用の推奨タグ (C# プログラミング ガイド)Recommended tags for documentation comments (C# programming guide)

コード内のドキュメント コメントは、C# コンパイラによって処理され、 /doc コマンド ライン オプションで指定した名前のファイルに XML 形式で出力されます。The C# compiler processes documentation comments in your code and formats them as XML in a file whose name you specify in the /doc command-line option. コンパイラによって生成されたファイルに基づいて最終的なドキュメントを作成するには、カスタム ツールを作成するか、DocFXSandcastle などのツールを使用します。To create the final documentation based on the compiler-generated file, you can create a custom tool, or use a tool such as DocFX or Sandcastle.

タグは、型や型メンバーなどのコード コンストラクターに対して処理されます。Tags are processed on code constructs such as types and type members.

注意

ドキュメント コメントは、名前空間に適用できません。Documentation comments cannot be applied to a namespace.

コンパイラは、有効な XML のタグをすべて処理します。The compiler will process any tag that is valid XML. ユーザー ドキュメントで一般的に使用される機能を提供するタグを次の表に示します。The following tags provide generally used functionality in user documentation.

TagsTags

<c> <para> <see>* <value>
<code> <param>* <seealso>*
<example> <paramref> <summary>
<exception>* <permission>* <typeparam>*
<include>* <remarks> <typeparamref>
<list> <inheritdoc> <returns>

(* は、コンパイラによって構文が検証されることを示します。)(* denotes that the compiler verifies syntax.)

ドキュメント コメントのテキストに山かっこを表示する場合は、<> の HTML エンコードを使用します。これはそれぞれ、&lt;&gt; になります。If you want angle brackets to appear in the text of a documentation comment, use the HTML encoding of < and > which is &lt; and &gt; respectively. このエンコードは次の例に示されています。This encoding is shown in the following example.

/// <summary>
/// This property always returns a value &lt; 1.
/// </summary>

関連項目See also