XML ドキュメント (Visual C++)

Visual C++ では、XML ドキュメントファイルに出力されるソースコードにコメントを追加することができます。このファイルは、コード内のクラスに関するドキュメントを作成するプロセスに入力することができます。

Visual C++ コードファイル内では、メソッドまたは型の定義の直前に XML ドキュメントコメントを配置する必要があります。次のシナリオでは、コメントを使用して IntelliSense QuickInfo データヒントを設定することができます。

Note

現在のリリースでは、テンプレートに対しても、テンプレートの種類を含む要素 (たとえば、テンプレートとしてパラメーターを取る関数) に対してもコードコメントは処理されません。このようなコメントを追加すると、未定義の動作が発生します。

ドキュメントコメントを含む XML ファイルの作成の詳細については、次の記事を参照してください。

対象	参照トピック
使用するコンパイラオプション	`/doc`
ドキュメントで一般的に使用される機能を提供するために使用できるタグ	ドキュメントコメント用の推奨タグ
コード内のコンストラクトを識別するために、コンパイラによって生成される ID 文字列	XML ファイルの処理
ドキュメントタグを区切る方法	Visual C++ ドキュメントタグの区切り記号
1 つまたは複数の XDC ファイルからの XML ファイルの生成。	XDCMake リファレンス
Visual Studio の機能領域に関連している XML に関する情報へのリンク	Visual Studio での XML

ドキュメントコメントのテキストに XML 特殊文字を配置する必要がある場合は、XML エンティティまたは CDATA セクションを使用する必要があります。

関連項目