Etiquetas XML recomendadas para comentários de documentação (Visual Basic)

O compilador Visual Basic pode processar comentários de documentação no seu código para um ficheiro XML. Pode utilizar ferramentas adicionais para processar o ficheiro XML em documentação.

São permitidos comentários XML em construções de códigos como tipos e membros do tipo. Para os tipos parciais, apenas uma parte do tipo pode ter comentários XML, embora não exista restrição em comentar os seus membros.

Nota

Os comentários documentais não podem ser aplicados em espaços de nome. A razão é que um espaço de nome pode abranger várias assembleias, e nem todos os conjuntos têm que ser carregados ao mesmo tempo.

O compilador processa qualquer etiqueta que seja válida XML. As seguintes tags fornecem uma funcionalidade comumente utilizada na documentação do utilizador.

• <c>
• <código>
• <exemplo>
• <exceção1>
• <incluir1>
• <lista>
• <para>
• <param1>
• <paramref>
• <permissão1>
• <observações>
• <devoluções>
• <ver1>
• <seealso1>
• <resumo>
• <typeparam1>
• <valor>

(¹ O compilador verifica a sintaxe.)

Nota

Se quiser que os suportes angulares apareçam no texto de um comentário de documentação, utilize < e >. Por exemplo, a corda "<text in angle brackets>" aparecerá como <text in angle brackets>.

Ver também

• Documentando o seu código com XML
• -doc
• Como: Criar Documentação XML