Compartilhar via

tarefa XDCMake

  • Artigo

Observação

Essa tarefa só está disponível ao usar o sistema de compilação C++.

Encapsula a ferramenta de Documentação XML (xdcmake.exe), que mescla arquivos de comentário (.xdc) do documento XML com um arquivo .xml.

Um arquivo .xdc será criado quando comentários de documentação forem fornecidos no código-fonte do C++ e compilados por meio da opção do compilador /doc. Para saber mais, consulte Referência XDCMake, Páginas de Propriedade da Ferramenta Geradora de Documento XML e a opção de ajuda de linha de comando (/?) para xdcmake.exe.

Comentários

Por padrão, a ferramenta xdcmake.exe dá suporte a algumas opções de linha de comando. Opções adicionais terão suporte quando a opção de linha de comando /old for especificada.

Parâmetros

A tabela a seguir descreve os parâmetros da tarefa XDCMake.

Parâmetro Descrição
AdditionalDocumentFile Parâmetro String[] opcional.

Especifica um ou mais arquivos .xdc adicionais para mesclagem.

Para saber mais, consulte a descrição Arquivos Adicionais de Documento nas Páginas de propriedade da Ferramenta Geradora de Documento XML. Consulte também as opções de linha de comando /old e /Fs para o xdcmake.exe.
AdditionalOptions Parâmetro String opcional.

Uma lista de opções, conforme especificado na linha de comando. Por exemplo, /<option1> /<option2> /<option#>. Use esse parâmetro para especificar opções não representadas por nenhum outro parâmetro da tarefa XDCMake.

Para saber mais, consulte Referência XDCMake, Páginas de Propriedade da Ferramenta Geradora de Documento XML e a ajuda da linha de comando (/?) para o xdcmake.exe.
DocumentLibraryDependencies Parâmetro Boolean opcional.

Se true e o projeto atual tiverem uma dependência em um projeto de biblioteca estática (.lib) na solução, os arquivos .xdc desse projeto de biblioteca serão incluídos no arquivo .xml de saída do projeto atual.

Para saber mais, confira a descrição Dependências de Biblioteca de Documentos nas Páginas de propriedade da Ferramenta Geradora de Documento XML.
OutputFile Parâmetro String opcional.

Substitui o nome de arquivo de saída padrão. O nome padrão é derivado do nome do primeiro arquivo .xdc processado.

Para saber mais, confira a opção /out:<nomearquivo> na Referência de XDCMake. Consulte também as opções de linha de comando /old e /Fo para o xdcmake.exe.
ProjectName Parâmetro String opcional.

O nome do projeto atual.
SlashOld Parâmetro Boolean opcional.

Se true, habilitará as opções adicionais do xdcmake.exe.

Para saber mais, consulte a opção de linha de comando /old para o xdcmake.exe.
Fontes Parâmetro ITaskItem[] obrigatório.

Define uma matriz de itens de arquivo de origem do MSBuild que pode ser consumida e emitida por tarefas.
SuppressStartupBanner Parâmetro Boolean opcional.

Se true, impedirá a exibição da mensagem de direitos autorais e de número de versão quando a tarefa for iniciada.

Para saber mais, consulte a opção /nologo em Referência XDCMake.
TrackerLogDirectory Parâmetro String opcional.

Especifica o diretório do log de rastreamento.

Confira também