/doc comentários de documentação do processo () (Opções do compilador translation from VPE for Csharp)
The /doc opção permite colocar comentários de documentação em um arquivo XML.
/doc:file
Argumentos
- file
O arquivo de saída para XML, que é preenchida com os comentários em arquivos de código-fonte da compilação.
Comentários
Nos arquivos de código fonte, comentários de documentação que precedem a seguir podem serão processados e adicionados ao arquivo XML:
Esses tipos definidos pelo usuário sistema autônomo um classe, delegado, or interface
Esses membros sistema autônomo um campo, evento, propriedade ou método
O arquivo de código de fonte que contém o principal é saída primeiro para o XML.
Para usar o arquivo XML gerado para uso com o IntelliSense recurso, permitem que o nome de arquivo do arquivo .xml ser o mesmo sistema autônomo sembly sistema autônomo deseja oferecer suporte e, em seguida, certifique-se de que o arquivo .xml está no mesmo diretório sistema autônomo sembly sistema autônomo.Assim, quando o assembly é referenciado no projeto Visual Studio, o arquivo .xml está localizado também.See Fornecendo comentários de código e para obter mais informações.
A menos que você compilar com /destino:módulo, fileconterá <assembly></assembly> Rótulos 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 aplica-se a entrada todos os arquivos; ou então, se definida em configurações do projeto, todos os arquivos do projeto.Para desabilitar os avisos relacionados a comentários da documentação para um arquivo específico ou seção de código, use aviso # pragma. |
See Recomendado Rótulos para comentários de documentação para obter maneiras de gerar documentação dos comentários no seu código.
Consulte Exemplo de documentação XML para uma amostra.
Para conjunto esta opção do compilador no ambiente de desenvolvimento do Visual Studio
em em aberto Propriedades página.
Modificar o Arquivo de documentação XMLpropriedade .
Para obter informações sobre como conjunto opção do compilador programaticamente, consulte DocumentationFile.