-doc (opções do compilador C#)-doc (C# Compiler Options)

A opção -doc permite colocar comentários de documentação em um arquivo XML.The -doc option allows you to place documentation comments in an XML file.

SintaxeSyntax

-doc:file  

ArgumentsArguments

file
O arquivo de saída para XML, que é populado com os comentários nos arquivos de código-fonte da compilação.The output file for XML, which is populated with the comments in the source code files of the compilation.

ComentáriosRemarks

Nos arquivos de código-fonte, os comentários de documentação que precedem o seguinte podem ser processados e adicionados ao arquivo XML:In source code files, documentation comments that precede the following can be processed and added to the XML file:

O arquivo de código-fonte que contém Main é gerado primeiro no XML.The source code file that contains Main is output first into the XML.

Para usar o arquivo .xml gerado para uso com o recurso IntelliSense, deixe o nome do arquivo .xml igual ao do assembly a que você deseja dar suporte e, em seguida, verifique se o arquivo .xml está no mesmo diretório que o assembly.To use the generated .xml file for use with the IntelliSense feature, let the file name of the .xml file be the same as the assembly you want to support and then make sure the .xml file is in the same directory as the assembly. Sendo assim, quando o assembly for referenciado no projeto do Visual Studio, o arquivo .xml também será encontrado.Thus, when the assembly is referenced in the Visual Studio project, the .xml file is found as well. Consulte Fornecendo comentários de código para obter mais informações.See Supplying Code Comments and for more information.

A menos que você compile com -target:module, file conterá marcas <assembly></assembly> especificando o nome do arquivo que contém o manifesto do assembly para o arquivo de saída da compilação.Unless you compile with -target:module, file will contain <assembly></assembly> tags specifying the name of the file containing the assembly manifest for the output file of the compilation.

Observação

A opção -doc se aplica a todos os arquivos de entrada ou, se definida nas Configurações do Projeto, todos os arquivos no projeto.The -doc option applies to all input files; or, if set in the Project Settings, all files in the project. Para desabilitar avisos relacionados aos comentários de documentação para um arquivo ou uma seção específica do código, use #pragma warning.To disable warnings related to documentation comments for a specific file or section of code, use #pragma warning.

Consulte Marcas recomendadas para comentários de documentação para ver maneiras de gerar a documentação dos comentários em seu código.See Recommended Tags for Documentation Comments for ways to generate documentation from comments in your code.

Para definir esta opção do compilador no ambiente de desenvolvimento do Visual StudioTo set this compiler option in the Visual Studio development environment

  1. Abra a página Propriedades do projeto.Open the project's Properties page.

  2. Clique na guia Build.Click the Build tab.

  3. Modifique a propriedade Arquivo de documentação XML.Modify the XML documentation file property.

Para saber mais sobre como definir essa opção do compilador programaticamente, veja DocumentationFile.For information on how to set this compiler option programmatically, see DocumentationFile.

Consulte tambémSee also