次の方法で共有


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

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

Visual C++ コード ファイルでは、XML ドキュメント コメントはメソッドまたは型定義前に直接ある必要があります。コメントは次のシナリオでは、Intellisense QuickInfo のデータのツールヒントの設定に使用できます:

  1. コードを伴う .winmd ファイルを含む Windows のランタイム コンポーネントとしてコンパイルするときは

  2. ソース・コードが現在のプロジェクトに含まれている場合。

  3. 型宣言および実装で同じヘッダー ファイルにあるライブラリ

[!メモ]

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

ドキュメント コメントによる .xml ファイルの作成の詳細については、次のトピックを参照してください。

参照する内容

参照項目

使用されるコンパイラ オプション

/doc

ドキュメントの汎用機能を提供するために使用できるタグ

ドキュメント コメントとして推奨されるタグ

コードの構造を識別するためにコンパイラが生成した ID 文字列

.xml ファイルの処理

ドキュメント タグを区切る方法

Visual C++ のドキュメント タグの区切り記号

.xml を生成する一つ以上のファイルの .xdc ファイルからします。

XDCMake の参照

Visual Studio の機能の領域に関連するように、XML に関する情報へのリンク

Visual Studio の XML

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

参照

概念

ランタイム プラットフォームのコンポーネントの拡張機能