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

  • [アーティクル]

コンパイラでソース コード ファイルのドキュメント コメントが処理され、ドキュメント コメントを含むソース コード ファイルごとに .xdc ファイルが作成されます。

構文

/doc[name]

引数

name
コンパイラによって作成される .xdc ファイルの名前。 コンパイルで 1 つの .cpp ファイルが渡される場合にのみ有効です。

解説

.xdc ファイルは、xdcmake.exe を使用して .xml ファイルに処理されます。 詳細については、「XDCMake リファレンス」を参照してください。

ドキュメントのコメントをソース コード ファイルに追加できます。 詳細については、「 ドキュメント コメント用の推奨タグ」を参照してください。

生成された .xml ファイルを IntelliSense で使用するには、.xml ファイルの名前をサポートするアセンブリと同じにして、その .xml ファイルをアセンブリと同じディレクトリに置きます。 アセンブリが Visual Studio プロジェクト内で参照されると、.xml ファイルも検出されます。 詳細については、IntelliSense の使用に関するページと XML コード コメントの追加に関するページをご覧ください。

Visual Studio 開発環境でこのコンパイラ オプションを設定するには

  1. プロジェクトの [プロパティ ページ] ダイアログ ボックスを開きます。 詳細については、Visual Studio での C++ コンパイラとビルド プロパティの設定に関する記事を参照してください。

  2. [構成プロパティ]>[C/C++]>[出力ファイル] のプロパティ ページを選択します。

  3. [XML ドキュメント ファイルの生成] プロパティを変更します。

このリンカーをコードから設定するには

関連項目

MSVC コンパイラ オプション
MSVC コンパイラ コマンド ラインの構文