Nota
O acesso a esta página requer autorização. Pode tentar iniciar sessão ou alterar os diretórios.
O acesso a esta página requer autorização. Pode tentar alterar os diretórios.
O compilador do Visual Basic pode processar comentários de documentação em seu código para um arquivo XML. Você pode usar ferramentas adicionais para processar o arquivo XML na documentação.
Comentários XML são permitidos em construções de código, como tipos e membros de tipo. Para tipos parciais, apenas uma parte do tipo pode ter comentários XML, embora não haja restrição para comentar seus membros.
Observação
Os comentários da documentação não podem ser aplicados a namespaces. O motivo é que um namespace pode abranger vários assemblies e nem todos os assemblies precisam ser carregados ao mesmo tempo.
O compilador processa qualquer tag que seja XML válido. As tags a seguir fornecem a funcionalidade comumente usada na documentação do usuário.
- <c>
- <código>
- <Exemplo>
- <exceção>1
- <incluem>1
- <Lista>
- <para>
- <param>1
- <Paramref>
- <permissão>1
- <Comentários>
- <devoluções>
- <ver>1
- <Ver também>1
- <Resumo>
- <typeparam>1
- <tipoparamref>
- <valor>
(1 O compilador verifica a sintaxe.)
Observação
Se quiser que os colchetes angulares apareçam no texto de um comentário da documentação, use < e >. Por exemplo, a cadeia de caracteres "<text in angle brackets>" aparecerá como <text in angle brackets>.
Ver também
Colabore connosco no GitHub
A origem deste conteúdo pode ser encontrada no GitHub, onde também pode criar e rever problemas e pedidos Pull. Para mais informações, consulte o nosso guia do contribuidor.
