/doc (ドキュメント コメントの処理) (C/C++)
コンパイラが、ソース コード ファイル内のドキュメント コメントを処理し、ドキュメント コメントを含む各ソース コード ファイルの .xdc ファイルを作成します。
/doc[name]
引数
- name
コンパイラが作成する .xdc ファイルの名前。コンパイルで .cpp ファイルが 1 つ渡される場合のみ有効です。
解説
.xdc ファイルは、xdcmake.exe で処理され .xml ファイルに挿入されます。詳細については、「XDCMake Reference」を参照してください。
ドキュメント コメントをソース コード ファイルに追加できます。詳細については、「Recommended Tags for Documentation Comments (Visual C++)」を参照してください。
/doc は /clr:oldSyntax と互換性がありません。詳細については、「/clr (共通言語ランタイムのコンパイル)」を参照してください。
生成された .xml ファイルで IntelliSense 機能を使用するには、サポートするアセンブリの名前と .xml ファイル名を同じにして、そのファイルをアセンブリと同じディレクトリに置いてください。アセンブリが Visual Studio プロジェクトで参照されると、.xml ファイルも検出されます。詳細については、「IntelliSense の使用方法」および「XML コード コメントの追加」を参照してください。
Visual Studio 開発環境でこのコンパイラ オプションを設定するには
プロジェクトの [プロパティ ページ] ダイアログ ボックスを開きます。詳細については、「方法 : プロジェクト プロパティ ページを開く」を参照してください。
[構成プロパティ] ノードを展開します。
[C/C++] ノードを展開します。
[出力ファイル] プロパティ ページをクリックします。
[XML ドキュメント ファイルの生成] プロパティを変更します。
このリンカーをコードから設定するには
- GenerateXMLDocumentationFiles を参照してください。