/doc (Opções do compilador de C#)

  • Artigo

O /doc opção permite que você coloque comentários da documentação em um arquivo XML.

/doc:file

Argumentos

  • file
    O arquivo de saída para XML, que é preenchida com os comentários nos arquivos de código fonte da compilação.

Comentários

Em arquivos de código-fonte, comentários de documentação que precedem a seguir podem ser processados e adicionados ao arquivo XML:

O arquivo de código de origem que contém o principal é saída primeiro para o XML.

Para usar o arquivo. XML gerado para uso com o IntelliSense recurso, deixe o nome de arquivo do arquivo. XML a ser o mesmo como o assembly que você deseja oferecer suporte e, em seguida, verifique se o arquivo. XML está no mesmo diretório do assembly.Assim, quando o assembly é referenciado no projeto Visual Studio, o arquivo. XML é encontrado também.Consulte Fornecendo comentários de código e para obter mais informações.

A menos que você compila com /target:module, file conterá <assembly> </assembly> marcas especificando o nome do arquivo que contém o manifesto do assembly para o arquivo de saída da compilação.

ObservaçãoObservação

A opção /doc aplica-se a todos os arquivos de entrada; ou então, se definido nas configurações do projeto, todos os arquivos no projeto.Para desativar os avisos relacionados a comentários da documentação para um arquivo específico ou uma seção de código, use aviso # pragma.

Consulte Recomendado marcas de comentários de documentação para obter maneiras de gerar documentação de comentários em seu código.

Para definir esta opção de compilador no ambiente de desenvolvimento Visual Studio

  1. Abra o projeto Propriedades página.

  2. Clique na guia Build.

  3. Modificar o arquivo de documentação XML propriedade.

Para obter informações sobre como definir essa opção de compilador programaticamente, consulte DocumentationFile.

Consulte também

Tarefas

Como: modificar propriedades do projeto e as definições de configuração

Outros recursos

Opções do compilador C#