XDCMake タスク
Note
このタスクは、C++ ビルド システムを使用している場合にのみ使用できます。
XML ドキュメント ツール (xdcmake.exe) をラップします。このツールは、XML ドキュメント コメント (.xdc) ファイルを .xml ファイルにマージします。
C++ のソース コードにドキュメンテーション コメントを記入し、/doc コンパイラ オプションでコンパイルすると、.xdc ファイルが作成されます。 詳細については、「XDCMake リファレンス」、「[XML ドキュメント ジェネレーター] プロパティ ページ」、xdcmake.exe のコマンドライン ヘルプ オプション (/?) をご覧ください。
解説
既定では、xdcmake.exe ツールはいくつかのコマンドライン オプションをサポートしています。 /old コマンドライン オプションを指定すると、追加のオプションがサポートされます。
パラメーター
XDCMake タスクのパラメーターの説明を次の表に示します。
| パラメーター | 説明 |
|---|---|
| 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 型のパラメーターです。 トラッカー ログのディレクトリを指定します。 |