XDCMake 任务

  • 项目

包装 XML 文档工具 (xdcmake.exe )，它将 XML 文档注释 (.xdc ) 文件合并到一个 .xml 文件中。

如果在 C++ 源代码中提供文档注释，并使用 /doc 编译器选项进行编译，就会创建“.xdc”文件。 有关详细信息，请参阅 XDCMake 参考、XML 文档生成器工具属性页和 xdcmake.exe 的命令行帮助选项 (/?)。

备注

默认情况下，xdcmake.exe 工具支持几个命令行选项。 如果你指定 /old 命令行选项，此工具还支持其他选项。

参数

下表介绍了 XDCMake 任务的参数。

参数 描述
AdditionalDocumentFile 可选 String [] 参数。

指定还要合并的一个或多个 .xdc 文件。

有关详细信息，请参阅 XML 文档生成器工具属性页中的附加文档文件说明。 另请参阅 xdcmake.exe 的“/old”和“/Fs”命令行选项。
AdditionalOptions 可选 String 参数。

在命令行上指定的选项列表。 例如 /<option1> /<option2> /<option#>。 此参数用于指定无法由其他任何 XDCMake 任务参数表示的选项。

有关详细信息，请参阅 XDCMake 参考、XML 文档生成器工具属性页和 xdcmake.exe 的命令行帮助 (/?)。
DocumentLibraryDependencies 可选 Boolean 参数。

若为 true 且当前项目与解决方案中的静态库 (.lib) 项目有依赖关系，那么当前项目的 .xml 文件输出中就会包含此库项目的 .xdc 文件。

有关详细信息，请参阅 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 参数。

指定跟踪器日志目录。

另请参阅