ドキュメント コメント用の推奨タグ

  • [アーティクル]

MSVC コンパイラにより、コード内のドキュメント コメントが処理され、コンパイルされるソース ファイルごとに XDC ファイルが作成されます。 次に、xdcmake.exe によって XDC ファイルが処理されて、XML ドキュメント ファイルが作成されます。 XML ファイルを加工してドキュメントを作成することは、自分のサイトで実行する必要がある項目です。

型や型メンバーなどのコンストラクトでタグが処理されます。

タグは型やメンバーの直前に置く必要があります。

Note

ドキュメント コメントは名前空間に適用できず、プロパティやイベントのアウトオブライン定義に置くことはできません。ドキュメント コメントは、クラス内宣言に置く必要があります。

コンパイラは、有効な XML のタグをすべて処理します。 次のタグによって、ユーザー ドキュメントで一般的に使用される機能が与えられます。

<c>
<code>
<example>
<exception>1
<include>1
<list>
<para>
<param>1
<paramref>1
<permission>1
<remarks>
<returns>
<see>1
<seealso>1
<summary>
<value>

  1. コンパイラによって構文が検証されます。

現行リリースの MSVC コンパイラでは、他の Visual Studio コンパイラでサポートされているタグである <paramref> がサポートされていません。 Visual C++ では、将来のリリースで <paramref> がサポートされる可能性があります。

関連項目

XML ドキュメント