XML に関するドキュメント (Visual C++)
Visual C++ では、.xml ファイルに処理される、ソース・コードにコメントを追加できます。このファイルは、コードのクラスに関するドキュメントを作成するプロセスに、入力があります。
Visual C++ コード ファイルでは、XML ドキュメント コメントはメソッドまたは型定義前に直接ある必要があります。コメントは次のシナリオでは、Intellisense QuickInfo のデータのツールヒントの設定に使用できます:
コードを伴う .winmd ファイルを含む Windows のランタイム コンポーネントとしてコンパイルするときは
ソース・コードが現在のプロジェクトに含まれている場合。
型宣言および実装で同じヘッダー ファイルにあるライブラリ
[!メモ]
現在のリリースでは、テンプレート型 (たとえば、テンプレートとしてパラメーターを受け取る関数) を含むテンプレートまたは任意のコード コメントは処理されません。このようなコメントを追加すると、未定義の動作が発生します。
ドキュメント コメントによる .xml ファイルの作成の詳細については、次のトピックを参照してください。
参照する内容 |
参照項目 |
|---|---|
使用されるコンパイラ オプション |
|
ドキュメントの汎用機能を提供するために使用できるタグ |
|
コードの構造を識別するためにコンパイラが生成した ID 文字列 |
|
ドキュメント タグを区切る方法 |
|
.xml を生成する一つ以上のファイルの .xdc ファイルからします。 |
|
Visual Studio の機能の領域に関連するように、XML に関する情報へのリンク |
設定する必要がある場合はドキュメントのテキストの XML の特殊文字をコメント アウトすると、エンティティまたは XML CDATA セクションを使用する必要があります。