XDCMake タスクXDCMake Task

XML ドキュメント ツール (xdcmake.exe) をラップします。このツールは、XML ドキュメント コメント (.xdc) ファイルを .xml ファイルにマージします。Wraps the XML Documentation tool (xdcmake.exe), which merges XML document comment (.xdc) files into an .xml file.

Visual C++ ソース コードにドキュメンテーション コメントを記入し、/doc コンパイラ オプションでコンパイルすると、.xdc ファイルが作成されます。An .xdc file is created when you provide documentation comments in your Visual C++ source code and compile by using the /doc compiler option. 詳細については、XDCMake リファレンスXML ドキュメント ジェネレーター プロパティ ページ、xdcmake.exe のコマンドライン ヘルプ オプション (/?) をご覧ください。For more information, see XDCMake Reference, XML Document Generator Tool Property Pages, and command-line help option (/?) for xdcmake.exe.

コメントRemarks

既定では、xdcmake.exe ツールはいくつかのコマンドライン オプションをサポートしています。By default, the xdcmake.exe tool supports a few command-line options. /old コマンドライン オプションを指定すると、追加のオプションがサポートされます。Additional options are supported when you specify the /old command-line option.

パラメーターParameters

XDCMake タスクのパラメーターの説明を次の表に示します。The following table describes the parameters of the XDCMake task.

パラメーターParameter 説明Description
AdditionalDocumentFileAdditionalDocumentFile 省略可能な String[] 型のパラメーターです。Optional String[] parameter.

結合する追加の .xdc ファイルを 1 つまたは複数指定します。Specifies one or more additional .xdc files to merge.

詳細については、XML ドキュメント ジェネレーター プロパティ ページ追加のドキュメント ファイルに関する説明をご覧ください。For more information, see the Additional Document Files description in XML Document Generator Tool Property Pages. xdcmake.exe については、コマンドライン オプションの /old/Fs も参照してください。Also see the /old and /Fs command-line options for xdcmake.exe.
AdditionalOptionsAdditionalOptions 省略可能な String 型のパラメーターです。Optional String parameter.

コマンド ラインで指定するオプションのリストです。A list of options as specified on the command line. たとえば、"/option1 /option2 /option#" のような形式です。For example, "/option1 /option2 /option#". 他の XDCMake タスク パラメーターでは表されないオプションを指定する場合は、このパラメーターを使用します。Use this parameter to specify options that are not represented by any other XDCMake task parameter.

詳細については、XDCMake リファレンスXML ドキュメント ジェネレーター プロパティ ページ、xdcmake.exe のコマンドライン ヘルプ (/?) をご覧ください。For more information, see XDCMake Reference, XML Document Generator Tool Property Pages, and command-line help (/?) for xdcmake.exe.
DocumentLibraryDependenciesDocumentLibraryDependencies 省略可能な Boolean 型のパラメーターです。Optional Boolean parameter.

true と現在のプロジェクトがソリューションのスタティック ライブラリ (.lib) プロジェクトに依存している場合、そのライブラリ プロジェクトの .xdc ファイルが現在のプロジェクトの .xml ファイル出力に含まれます。If true and the current project has a dependency on a static library (.lib) project in the solution, the .xdc files for that library project are included in the .xml file output for the current project.

詳細については、XML ドキュメント ジェネレーター プロパティ ページドキュメント ライブラリの依存関係に関する説明をご覧ください。For more information, see the Document Library Dependencies description in XML Document Generator Tool Property Pages.
OutputFileOutputFile 省略可能な String 型のパラメーターです。Optional String parameter.

既定の出力ファイル名をオーバーライドします。Overrides the default output file name. 既定の名前は、処理される最初の .xdc ファイルの名前から派生します。The default name is derived from the name of the first .xdc file that is processed.

詳細については、「XDCMake リファレンス」の /out:filename オプションの説明を参照してください。For more information, see the /out:filename option in XDCMake Reference. xdcmake.exe については、コマンドライン オプションの /old/Fo も参照してください。Also see the /old and /Fo command-line options for xdcmake.exe.
ProjectNameProjectName 省略可能な String 型のパラメーターです。Optional String parameter.

現在のプロジェクトの名前。The name of the current project.
SlashOldSlashOld 省略可能な Boolean 型のパラメーターです。Optional Boolean parameter.

true の場合、追加の xdcmake.exe オプションを有効にします。If true, enables additional xdcmake.exe options.

詳細については、xdcmake.exe の /old コマンド ライン オプションを参照してください。For more information, see the /old command-line option for xdcmake.exe.
SourcesSources 必須の ITaskItem[] 型のパラメーターです。Required ITaskItem[] parameter.

タスクで使用および生成できる MSBuild ソース ファイル アイテムの配列を定義します。Defines an array of MSBuild source file items that can be consumed and emitted by tasks.
SuppressStartupBannerSuppressStartupBanner 省略可能な Boolean 型のパラメーターです。Optional Boolean parameter.

true の場合、タスクの開始時に著作権およびバージョン番号のメッセージが表示されないようにします。If true, prevents the display of the copyright and version number message when the task starts.

詳細については、「XDCMake リファレンス」の /nologo オプションの説明を参照してください。For more information, see the /nologo option in XDCMake Reference.
TrackerLogDirectoryTrackerLogDirectory 省略可能な String 型のパラメーターです。Optional String parameter.

トラッカー ログのディレクトリを指定します。Specifies the directory for the tracker log.

関連項目See Also

Task Reference (タスク リファレンス)Task Reference