/doc (opções do compilador C#)
A opção de /doc permite que você coloque comentários sobre a documentação do em um arquivo XML.
/doc:file
Arguments
- file
O arquivo de saída XML para, que é populado com os comentários em arquivos de origem da compilação.
Comentários
Em arquivos de origem, os comentários sobre a documentação que precedem o seguinte podem ser processados e adicionado ao arquivo XML:
Tipos definidos pelo usuário como classe, delegado, ou interface
Membros como um campo, evento, propriedade, ou o método
O arquivo de origem que contém o main é o primeiro saída em XML.
Para usar o arquivo .xml gerado para uso com o recurso de O IntelliSense , deixe o nome do arquivo .xml ser igual ao assembly desejar oferecer suporte e certificar-se no arquivo .xml estiver no mesmo diretório que o assembly. Portanto, quando o assembly for referenciado no projeto do Visual Studio, o arquivo .xml for encontrado também. Fornecendo comentários de código consulte e para obter mais informações.
A menos que você compile com /target: módulo, file conterá <o assembly></marcas do assembly> que especifica o nome do arquivo que contém o manifesto do assembly para o arquivo de saída de compilação.
Dica
A opção /doc se aplica a todos os arquivos de entrada; ou, se definido em configurações de projeto, todos os arquivos no projeto.Para desabilitar avisos relacionados a comentários sobre a documentação para um arquivo específico ou a seção de código, use aviso de #pragma.
Consulte Marcas recomendadas para comentários sobre a documentação para as maneiras que gerenciam a documentação de comentários em seu código.
Para definir esta opção do compilador no ambiente de desenvolvimento do Visual Studio
Abra a página de Propriedades do projeto.
Clique na guia Build.
Modifique a propriedade de Arquivo de Documentação XML .
Para obter informações sobre como definir programaticamente essa opção do compilador, consulte DocumentationFile.
Consulte também
Tarefas
Como modificar as propriedades de projeto e as definições de configuração