XDCMake タスク
XML ドキュメント ツール (xdcmake.exe) をラップします。このツールは、XML ドキュメント コメント (.xdc) ファイルを .xml ファイルにマージします。
.xdc ファイルが作成されるのは、Visual C++ ソース コードでドキュメント コメントを指定し、/doc コンパイラ オプションを使用してコンパイルしたときです。詳細については、「XDCMake の参照」、「[XML ドキュメント ジェネレーター] プロパティ ページ」、および xdcmake.exe のコマンド ライン ヘルプ オプション (/?) を参照してください。
解説
既定では、xdcmake.exe ツールでサポートされるのは、一部のコマンド ライン オプションです。追加のオプションをサポートするには、/old コマンド ライン オプションを指定します。
パラメーター
XDCMake タスクのパラメーターの説明を次の表に示します。
パラメーター |
Description |
|---|---|
AdditionalDocumentFile |
省略可能な String[] 型のパラメーターです。 マージする追加の .xdc ファイルを 1 つ以上指定します。 詳細については、「[XML ドキュメント ジェネレーター] プロパティ ページ」の "追加ドキュメント ファイル" の説明を参照してください。また、xdcmake.exe の /old コマンド ライン オプションと /Fs コマンド ライン オプションも参照してください。 |
AdditionalOptions |
省略可能な String 型のパラメーターです。 コマンド ラインで指定するオプションのリストです。たとえば、"/option1 /option2 /option#" のように指定します。他の XDCMake タスク パラメーターでは表されないオプションを指定する場合は、このパラメーターを使用します。 詳細については、「XDCMake の参照」、「[XML ドキュメント ジェネレーター] プロパティ ページ」、および xdcmake.exe のコマンド ライン ヘルプ (/?) を参照してください。 |
DocumentLibraryDependencies |
省略可能な Boolean 型のパラメーターです。 true の場合、現在のプロジェクトがソリューション内のスタティック ライブラリ (.lib) プロジェクトに依存しているときは、現在のプロジェクトについて、そのライブラリ プロジェクトの .xdc ファイルが .xml ファイル出力に含まれます。 詳細については、「[XML ドキュメント ジェネレーター] プロパティ ページ」の "ドキュメント ライブラリの依存関係" の説明を参照してください。 |
OutputFile |
省略可能な String 型のパラメーターです。 既定の出力ファイル名をオーバーライドします。既定の名前は、処理される最初の .xdc ファイルの名前を基に生成されます。 詳細については、「XDCMake の参照」の /out:filename オプションの説明を参照してください。また、xdcmake.exe の /old コマンド ライン オプションと /Fo コマンド ライン オプションも参照してください。 |
ProjectName |
省略可能な String 型のパラメーターです。 現在のプロジェクトの名前です。 |
SlashOld |
省略可能な Boolean 型のパラメーターです。 true の場合、追加の xdcmake.exe オプションを有効にします。 詳細については、xdcmake.exe の /old コマンド ライン オプションを参照してください。 |
Sources |
必須の ITaskItem[] 型のパラメーターです。 タスクで使用および生成できる MSBuild ソース ファイル アイテムの配列を定義します。 |
SuppressStartupBanner |
省略可能な Boolean 型のパラメーターです。 true の場合、タスクの開始時に著作権およびバージョン番号のメッセージが表示されないようにします。 詳細については、「XDCMake の参照」の /nologo オプションの説明を参照してください。 |
TrackerLogDirectory |
省略可能な String 型のパラメーターです。 トラッカー ログのディレクトリを指定します。 |