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

Visual C++ では、.xml ファイルに出力されるソース コードにコメントを追加することができます。In Visual C++, you can add comments to your source code that will be processed to an .xml file. このファイルは、コード内のクラスに関するドキュメントを作成するプロセスに入力することができます。This file can then be the input to a process that creates documentation for the classes in your code.

Visual C++ コード ファイル内では、メソッドまたは型の定義の直前に XML ドキュメント コメントを配置する必要があります。In a Visual C++ code file, XML documentation comments must be located directly prior to a method or type definition. 次のシナリオでは、コメントを使用して IntelliSense QuickInfo データ ヒントを設定することができます。The comments can be used to populate the IntelliSense QuickInfo data tip in the following scenarios:

  1. 付属の .winmd ファイルを使用してコードを Windows ランタイム コンポーネントとしてコンパイルする場合when the code is compiled as a Windows Runtime component with an accompanying .winmd file

  2. 現在のプロジェクトにソース コードを取り込む場合when the source code is included in the current project

  3. 型の宣言と実装が同じヘッダー ファイルに置かれているライブラリの場合in a library whose type declarations and implementations are located in the same header file


現在のリリースでは、テンプレートに対しても、テンプレートの種類を含む要素 (たとえば、テンプレートとしてパラメーターを取る関数) に対してもコード コメントは処理されません。In the current release, code comments are not processed on templates or anything containing a template type (for example, a function taking a parameter as a template). このようなコメントを追加すると、未定義の動作が発生します。Adding such comments will result in undefined behavior.

ドキュメント コメントを含む .xml ファイルの作成の詳細については、次のトピックを参照してください。For details on creating an .xml file with documentation comments, see the following topics.

参照する内容For information about 参照トピックSee
使用するコンパイラ オプションThe compiler options to use /doc/doc
ドキュメントで一般的に使用される機能を提供するために使用できるタグTags you can use to provide commonly used functionality in documentation ドキュメント コメントとして推奨されるタグRecommended Tags for Documentation Comments
コード内のコンストラクトを識別するために、コンパイラによって生成される ID 文字列The ID strings that the compiler produces to identify the constructs in your code .xml ファイルの処理Processing the .xml File
ドキュメント タグを区切る方法How to delimit documentation tags Visual C++ ドキュメント タグの区切り記号Delimiters for Visual C++ Documentation Tags
1 つまたは複数の .xdc ファイルからの .xml ファイルの生成。Generating an .xml file from one or more .xdc files. XDCMake リファレンスXDCMake Reference
Visual Studio の機能領域に関連している XML に関する情報へのリンクLinks to information about XML as it relates to Visual Studio feature areas Visual Studio での XMLXML in Visual Studio

ドキュメント コメントのテキストに XML 特殊文字を配置する必要がある場合は、XML エンティティまたは CDATA セクションを使用する必要があります。If you need to put XML special characters in the text of a documentation comment, you must use XML entities or a CDATA section.

関連項目See also

ランタイム プラットフォームのコンポーネントの拡張機能Component Extensions for Runtime Platforms