/doc

Artigo
02/25/2013

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

/doc[+ | -]
' -or-
/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 num arquivo XML.Especificar - é o equivalente de não especificar /doc, fazendo com que nenhuma informação 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 de arquivo contém um espaço, coloque o nome entre aspas (" ").

Comentários

A opção /doc controla se o compilador gera um arquivo XML contendo 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 para o arquivo XML do arquivo executável ou biblioteca que está sendo criada pelo compilador.Se você usar /doc- ou não especificar a opção /doc , o compilador não cria um arquivo XML.

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

Tipos definidos pelo usuário, como um CLASS ou interface
Membros, como um campo, Evento, propriedade, Função ou sub-rotina.

Para usar o arquivo XML gerado com o recurso Visual Studio IntelliSense,faça com que o nome do arquivo XML seja o mesmo do conjunto de módulos que você quer suportar.Certifique-se de que o arquivo XML esteja no mesmo diretório do conjunto de módulos (assembly) para que quando o assembly for referenciado no projeto Visual Studio,o arquivo .xml seja encontrado também.Arquivos de documentação XML não são necessários para IntelliSense para funcionar com código em um projeto ou em projetos referenciados por um projeto.

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

Consulte Recomendado marcas XML para comentários da documentação (Visual Basic) para ver maneiras de gerar documentação de comentários em seu código.

Configurar /doc no ambiente de desenvolvimento integrado Visual Studio

Tenha um projeto selecionado no Solution Explorer.No menu Project, clique em Properties..Para obter mais informações, consulte Introdução ao Project Designer.
Clique na guia Compile.
Defina o valor na caixa Generate XML documentation file .

Exemplo

Consulte Documentar o seu código com XML (Visual Basic) para uma amostra.

Consulte também

Conceitos

Documentar o seu código com XML (Visual Basic)

Outros recursos

Visual Basic compilador de linha de comando

Partilhar via