Observação
O acesso a essa página exige autorização. Você pode tentar entrar ou alterar diretórios.
O acesso a essa página exige autorização. Você 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 nenhuma 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 marca que seja XML válida. As seguintes marcas fornecem as funcionalidades geralmente usadas na documentação do usuário.
- <c>
- <código>
- <exemplo>
- <exceção>1
- <incluir>1
- <lista>
- <para>
- <param>1
- <paramref>
- <permissão>1
- <Observações>
- <Retorna>
- <ver>1
- <seealso>1
- <resumo>
- <typeparam>1
- <typeparamref>
- <valor>
(1 O compilador verifica a sintaxe.)
Observação
Se você quiser que colchetes angulares apareçam no texto de um comentário de documentação, use < e >. Por exemplo, a cadeia de caracteres "<text in angle brackets>" aparecerá como <text in angle brackets>.
Consulte também
Colaborar conosco no GitHub
A fonte deste conteúdo pode ser encontrada no GitHub, onde você também pode criar e revisar problemas e solicitações de pull. Para obter mais informações, confira o nosso guia para colaboradores.
