Compartilhar via


Tarefa de XDCMake

Ajusta a ferramenta de documentação XML (xdcmake.exe), que mescla de arquivos de comentário (.xdc) do documento XML em um arquivo. XML.

Um arquivo de .xdc é criado quando você fornecer comentários de documentação no seu código-fonte do Visual C++ e a compilação usando a /doc opção de compilador. Para obter mais informações, consulte XDCMake Reference, Páginas de propriedades de ferramenta do gerador de documento XMLe a opção de linha de comando de Ajuda (/?) para xdcmake.exe.

Comentários

Por padrão, a ferramenta xdcmake.exe oferece suporte a algumas opções de linha de comando. Há suporte para opções adicionais quando você especifica o /old opção de linha de comando.

Parâmetros

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

Parâmetro

Descrição

AdditionalDocumentFile

Opcional String[] parâmetro.

Especifica um ou mais arquivos de .xdc adicionais para mesclar.

Para obter mais informações, consulte o Arquivos adicionais do documento descrição na Páginas de propriedades de ferramenta do gerador de documento XML. Consulte também o /old e /Fs Opções de linha de comando para xdcmake.exe.

AdditionalOptions

Opcional String parâmetro.

Uma lista de opções, conforme especificado na linha de comando. Por exemplo, "/option# de /option2 /option1". Use este parâmetro para especificar as opções que não são representadas por outros XDCMake parâmetro da tarefa.

Para obter mais informações, consulte XDCMake Reference, Páginas de propriedades de ferramenta do gerador de documento XMLe a Ajuda de linha de comando (/?) para xdcmake.exe.

DocumentLibraryDependencies

Opcional Boolean parâmetro.

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

Para obter mais informações, consulte o As dependências de biblioteca de documentos descrição na Páginas de propriedades de ferramenta do gerador de documento XML.

OutputFile

Opcional String parâmetro.

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

Para obter mais informações, consulte o /out:filename opção na XDCMake Reference. Consulte também o /old e /Fo Opções de linha de comando para xdcmake.exe.

ProjectName

Opcional String parâmetro.

O nome do projeto atual.

SlashOld

Opcional Boolean parâmetro.

Se true, permite opções de xdcmake.exe adicionais.

Para obter mais informações, consulte o /old a opção de linha de comando para xdcmake.exe.

Sources

Obrigatório ITaskItem[] parâmetro.

Define uma matriz dos itens de arquivo de origem de MSBuild que pode ser consumido e emitido por tarefas.

SuppressStartupBanner

Opcional Boolean parâmetro.

Se true, impede a exibição do número de versão e copyright mensagem quando inicia a tarefa.

Para obter mais informações, consulte o /nologo opção na XDCMake Reference.

TrackerLogDirectory

Opcional String parâmetro.

Especifica o diretório para o log do controlador.

Consulte também

Outros recursos

Referência de tarefa do MSBuild