XML ドキュメント (Visual C++)
Visual C++ では、XML ドキュメント ファイルに出力されるソース コードにコメントを追加することができます。 このファイルは、コード内のクラスに関するドキュメントを作成するプロセスに入力することができます。
Visual C++ コード ファイル内では、メソッドまたは型の定義の直前に XML ドキュメント コメントを配置する必要があります。 次のシナリオでは、コメントを使用して IntelliSense QuickInfo データ ヒントを設定することができます。
WINMD ファイルを使用してコードを Windows ランタイム コンポーネントとしてコンパイルする場合
現在のプロジェクトにソース コードを取り込む場合
型の宣言と実装が同じヘッダー ファイルに置かれているライブラリの場合
Note
現在のリリースでは、テンプレートに対しても、テンプレートの種類を含む要素 (たとえば、テンプレートとしてパラメーターを取る関数) に対してもコード コメントは処理されません。 このようなコメントを追加すると、未定義の動作が発生します。
ドキュメント コメントを含む XML ファイルの作成の詳細については、次の記事を参照してください。
| 情報 | 参照トピック |
|---|---|
| 使用するコンパイラ オプション | /doc |
| ドキュメントで一般的に使用される機能を提供するために使用できるタグ | ドキュメント コメント用の推奨タグ |
| コード内のコンストラクトを識別するために、コンパイラによって生成される ID 文字列 | XML ファイルの処理 |
| ドキュメント タグを区切る方法 | Visual C++ ドキュメント タグの区切り記号 |
| 1 つまたは複数の XDC ファイルからの XML ファイルの生成。 | XDCMake リファレンス |
| Visual Studio の機能領域に関連している XML に関する情報へのリンク | Visual Studio での XML |
ドキュメント コメントのテキストに XML 特殊文字を配置する必要がある場合は、XML エンティティまたは CDATA セクションを使用する必要があります。