ドキュメント コメントとして推奨されるタグ (Visual C++)

Visual C++ コンパイラは、コードのドキュメント コメントを処理し、各コンパイル単位の .xdc ファイルを作成し、xdcmake.exe は、.xml ファイルに .xdc ファイルを処理します。ドキュメントを作成する .xml ファイルを処理することにより、サイトで実装する必要がある詳細です。

タグは、型や型メンバーなどの構成要素で処理されます。

タグは、型またはメンバーを付ける必要があります。

[!メモ]

ドキュメント コメントはプロパティとイベントの名前空間には、調和しない定義に適用できません; ドキュメント コメントは内部クラスの申告になります。

C# コンパイラは、有効な 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.コンパイラが構文を検証します。

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

参照

その他の技術情報

XML に関するドキュメント (Visual C++)