XDCMake - задача
Примечание.
Эта задача доступна только при использовании системы сборки C++.
Является оболочкой для средства XML-документации (xdcmake.exe), которая помещает в XML-файл файлы комментариев (XDC-файлы) для файла XML.
Файл XDC создается при добавлении комментариев к документации в исходный код C++ и выполнении компиляции с использованием параметра компиляции /doc. Дополнительные сведения см. в разделах Справочник по XDCMake, Страницы свойств средства создания XML-документов, а также в разделе справки, вызываемом с помощью параметра командной строки (/?) для файла xdcmake.exe.
Замечания
По умолчанию средство xdcmake.exe поддерживает несколько параметров командной строки. Для поддержки дополнительных параметров необходимо указать параметр командной строки /old.
Параметры
В следующей таблице описываются параметры задачи XDCMake.
| Параметр | Описание |
|---|---|
| AdditionalDocumentFile | Необязательный параметр типа String[]. Указывает один или несколько дополнительных файлов XDC для слияния. Дополнительные сведения см. в описании параметра Дополнительные файлы документации в разделе Страницы свойств средства создания XML-документов. Также см. описание параметров командной строки /old и /Fs для файла xdcmake.exe. |
| AdditionalOptions | Необязательный параметр String . Список параметров, как указано в командной строке. Например, /<параметр1> /<параметр2> /<параметрN>. Этот параметр используется для указания параметров, не представленных каким-либо другим параметром задачи XDCMake. Дополнительные сведения см. в разделах Справочник по XDCMake, Страницы свойств средства создания XML-документов, а также в разделе справки, вызываемом с помощью параметра командной строки (/?) для файла xdcmake.exe. |
| DocumentLibraryDependencies | Необязательный параметр Boolean . Если имеет значение true и текущий проект содержит зависимости от проекта статической библиотеки (.lib) в решении, файлы XDC для такого проекта библиотеки включаются в выходной файл XML для текущего проекта.Дополнительные сведения см. в описании параметра Зависимости библиотек документов в разделе Страницы свойств средства создания XML-документов. |
| OutputFile | Необязательный параметр String . Переопределяет имя выходного файла по умолчанию. Имя по умолчанию является производным от имени первого обработанного файла XDC. Дополнительные сведения см. в описании параметра /out:<имя_файла> в разделе Справочник по XDCMake. Также см. описание параметров командной строки /old и /Fo для файла xdcmake.exe. |
| Имя проекта | Необязательный параметр String . Имя текущего проекта. |
| SlashOld | Необязательный параметр Boolean . Если имеет значение true, могут использоваться дополнительные параметры для xdcmake.exe.Дополнительные сведения см. в описании параметра командной строки /old для xdcmake.exe. |
| Источники | Обязательный параметр ITaskItem[] .Определяет массив элементов исходного файла MSBuild, который может использоваться и создаваться задачами. |
| SuppressStartupBanner | Необязательный параметр Boolean . Если задано значение true, запрещается отображение сообщения о номере версии и авторских правах при запуске задачи.Дополнительные сведения см. в описании параметра /nologo в разделе Справочник по XDCMake. |
| TrackerLogDirectory | Необязательный параметр String . Задает каталог для журнала отслеживания. |