-doc

  • Artigo

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

Syntax

-doc[+ | -]

ou

-doc:file

Argumentos

Termo Definição
+ | - Opcional. Especificar +, ou apenas -doc, faz com que o compilador gere informações sobre a documentação e as coloque em um arquivo XML. Especificar - é equivalente a não especificar -doc, fazendo com que nenhuma informação de documentação seja criada.
file Necessá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, coloque o nome entre aspas (" ").

Comentários

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

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

Para usar o arquivo XML gerado com o recurso IntelliSense do Visual Studio, deixe o nome do arquivo XML ser o mesmo que o assembly para o qual você deseja dar suporte. Certifique-se de que o arquivo XML esteja no mesmo diretório que o assembly de modo que, ao referenciar o assembly 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 o IntelliSense funcionar com o código dentro do projeto ou em projetos referenciados por um projeto.

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

Veja Marcas de Comentário XML para descobrir as maneiras de gerar documentação de comentários em seu código.

Para configurar -doc no ambiente de desenvolvimento integrado do Visual Studio
1. Selecione um projeto 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

Veja Como documentar o código com XML para obter um exemplo.

Confira também