/doc ( Opçõesdo compilador de C#)
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 XML, que é preenchida com comentários em 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:
Tipos definidos pelo usuário como um classe, delegar, ou interface
Tais membros como um campo, evento, propriedade, ou método
O arquivo de código de origem que contém o principal é saída primeiro para o XML.
Para usar o arquivo. XML de gerado para uso com o IntelliSense recurso, deixe o nome de arquivo do arquivo. XML a ser o mesmo assembly que você deseja oferecer suporte e verifique se o arquivo. XML está no mesmo diretório do assembly. Assim, quando o assembly é referenciado no projeto Visual Studio, o arquivo. XML for encontrado bem. Consulte Fornecendo comentários de código e para obter mais informações.
A menos que você compilar 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.
.gif "Observação") Observação |
|---|
A opção /doc se aplica 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 # pragma aviso. |
Consulte Recomendado marcas de comentários de documentação maneiras de gerar a documentação de comentários em seu código.
Para definir esta opção de compilador no ambiente de desenvolvimento Visual Studio
Abra o projeto Propriedades página.
Modificar o Arquivo de documentação XML propriedade.
Para obter informações sobre como definir esta opção de compilador programaticamente, consulte DocumentationFile.