XDCMake (tarea)

  • Artículo

Nota:

Esta tarea solo está disponible cuando se usa el sistema de compilación de C++.

Incluye la herramienta Documentación XML (xdcmake.exe), que combina archivos de comentarios de documento XML ( .xdc) en un archivo .xml.

Se crea un archivo .xdc cuando proporciona comentarios de documentación en el código fuente de C++ y compila mediante la opción del compilador /doc. Para más información, consulte Referencia de XDCMake, Páginas de propiedades de la herramienta Generador de documentos XML y la opción de ayuda de la línea de comandos ( /? ) de xdcmake.exe.

Observaciones

De forma predeterminada, la herramienta xdcmake.exe admite algunas opciones de la línea de comandos. Se admiten opciones adicionales al especificar la opción de la línea de comandos /old.

Parámetros

En la tabla siguiente se describen los parámetros de la tarea XDCMake.

Parámetro Description
AdditionalDocumentFile Parámetro String[] opcional.

Especifica uno o más archivos .xdc adicionales que se van a combinar.

Para más información, consulte la descripción Archivos de documento adicionales en Páginas de propiedades de la herramienta Generador de documentos XML. Consulte también las opciones de la línea de comandos /old y /Fs de xdcmake.exe.
AdditionalOptions Parámetro String opcional.

Una lista de opciones especificada en la línea de comando. Por ejemplo, /<option1> /<option2> /<option#>. Use este parámetro para especificar opciones que no están representadas por ningún otro parámetro de tarea XDCMake.

Para más información, consulte Referencia de XDCMake, Páginas de propiedades de la herramienta Generador de documentos XML y la ayuda de la línea de comandos ( /? ) de xdcmake.exe.
DocumentLibraryDependencies Parámetro Boolean opcional.

Si es true y el proyecto actual tiene una dependencia en un proyecto de biblioteca estática ( .lib) en la solución, los archivos .xdc de ese proyecto de biblioteca se incluyen en la salida del archivo .xml para el proyecto actual.

Para más información, consulte la descripción Dependencias de biblioteca de documentos en Páginas de propiedades de la herramienta Generador de documentos XML.
OutputFile Parámetro String opcional.

Reemplaza el nombre del archivo de salida predeterminado. El nombre predeterminado se deriva del nombre del primer archivo .xdc procesado.

Para más información, vea la opción /out:<nombre de archivo> en Referencia de XDCMake. Consulte también las opciones de la línea de comandos /old y /Fo de xdcmake.exe.
ProjectName Parámetro String opcional.

Nombre del proyecto actual.
SlashOld Parámetro Boolean opcional.

Si es true, habilita opciones adicionales de xdcmake.exe.

Para más información, consulte la opción de línea de comandos /old de xdcmake.exe.
Sources Parámetro ITaskItem[] requerido.

Define una matriz de elementos de archivo origen de MSBuild que las tareas pueden consumir y emitir.
SuppressStartupBanner Parámetro Boolean opcional.

Si es true, evita que se muestre el copyright y el mensaje de número de versión cuando la tarea se inicia.

Para más información, consulte la opción /nologo de Referencia de XDCMake.
TrackerLogDirectory Parámetro String opcional.

Especifica el directorio de registro de seguimiento.

Vea también