Partilhar via

-doc

  • Artigo

Processa comentários de documentação para um arquivo XML.

Sintaxe

-doc[+ | -]

ou

-doc:file

Argumentos

Termo Definição
+ | - Opcional. Especificar +, ou apenas -doc, faz com que o compilador gere informações de documentação e as coloque em um arquivo XML. Especificar - é o equivalente a não especificar -doc, fazendo com que nenhuma informação documental seja criada.
file Obrigatório se -doc: for usado. Especifica o arquivo XML de saída, que é preenchido com os comentários dos arquivos de código-fonte da compilação. Se o nome do arquivo contiver um espaço, rodeie o nome com aspas (" ").

Observações

A -doc opção controla se o compilador gera um arquivo XML contendo os comentários da documentação. Se você usar a -doc:file sintaxe, o file parâmetro especifica o nome do arquivo XML. Se você usar -doc ou -doc+, o compilador tirará o nome do arquivo XML do arquivo executável ou biblioteca que o compilador está criando. Se você usar -doc- ou não especificar a -doc opção, o compilador não criará um arquivo XML.

Em arquivos de código-fonte, os comentários da documentação podem preceder as seguintes definições:

Para usar o arquivo XML gerado com o recurso IntelliSense do Visual Studio, permita que o nome do arquivo XML seja o mesmo que o assembly que você deseja suportar. Verifique se o arquivo XML está no mesmo diretório que o assembly para que, quando o assembly for referenciado no projeto do Visual Studio, o arquivo .xml também seja encontrado. Os arquivos de documentação XML não são necessários para que o IntelliSense funcione para código dentro de um projeto ou em projetos referenciados por um projeto.

A menos que você compile com -target:module, o arquivo XML contém as tags <assembly></assembly>. Essas tags especificam o nome do arquivo que contém o manifesto do assembly para o arquivo de saída da compilação.

Consulte Tags de comentário XML para obter maneiras de gerar documentação a partir de comentários em seu código.

Para definir -doc no ambiente de desenvolvimento integrado do Visual Studio
1. Tenha um projeto selecionado no Gerenciador de Soluções. No menu Projeto, clique em Propriedades.
2. Clique na guia Compilar .
3. Defina o valor na caixa Gerar arquivo de documentação XML.

Exemplo

Consulte Documentando seu código com XML para obter um exemplo.

Consulte também