/doc (ドキュメント コメントの処理) (C/C++)/doc (Process Documentation Comments) (C/C++)

ソース コード ファイル内およびドキュメントのコメントを含むソース コード ファイルごとに .xdc ファイルを作成するコンパイラ ドキュメント コメントの処理をします。Causes the compiler to process documentation comments in source code files and to create an .xdc file for each source code file that has documentation comments.

構文Syntax

/doc[name]/doc[name]

引数Arguments

namename
コンパイラで作成される .xdc ファイルの名前。The name of the .xdc file that the compiler will create. 1 つの .cpp ファイルがコンパイル時に渡されるときにのみ有効です。Only valid when one .cpp file is passed in the compilation.

RemarksRemarks

.Xdc ファイルは、xdcmake.exe の .xml ファイルに処理されます。The .xdc files are processed into an .xml file with xdcmake.exe. 詳細については、次を参照してください。 XDCMake リファレンスします。For more information, see XDCMake Reference.

ソース コード ファイルには、ドキュメントのコメントを追加できます。You can add documentation comments to your source code files. 詳細については、「 ドキュメント コメント用の推奨タグ」を参照してください。For more information, see Recommended Tags for Documentation Comments.

IntelliSense を備えた、生成された .xml ファイルを使用するには、.xml ファイルをサポートし、.xml ファイルを配置するアセンブリと同じアセンブリと同じディレクトリ内のファイル名を確認します。To use the generated .xml file with IntelliSense, make the file name of the .xml file the same as the assembly that you want to support and put the .xml file is in the same directory as the assembly. アセンブリは、Visual Studio プロジェクトで参照されて、.xml ファイルはあります。When the assembly is referenced in the Visual Studio project, the .xml file is also found. 詳細については、次を参照してください。を使用して IntelliSenseXML コード コメントします。For more information, see Using IntelliSense and Supplying XML Code Comments.

Visual Studio 開発環境において、このコンパイラ オプションを設定する方法To set this compiler option in the Visual Studio development environment

  1. プロジェクトの [プロパティ ページ] ダイアログ ボックスを開きます。Open the project's Property Pages dialog box. 詳細については、次を参照してください。 Visual Studio での設定の C++ コンパイラとビルド プロパティします。For details, see Set C++ compiler and build properties in Visual Studio.

  2. 選択、構成プロパティ > C/C++ > 出力ファイルプロパティ ページ。Select the Configuration Properties > C/C++ > Output Files property page.

  3. 変更、 XML ドキュメント ファイルの生成プロパティ。Modify the Generate XML Documentation Files property.

このリンカーをコードから設定するにはTo set this linker option programmatically

関連項目See also

MSVC コンパイラ オプションMSVC Compiler Options
MSVC コンパイラ コマンド ラインの構文MSVC Compiler Command-Line Syntax