marcações XML recomendadas para comentários da documentação (Visual Basic)

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.

Os comentários XML são processados em constructos de código tais 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 de documentação não podem ser aplicados a namespaces. O motivo é que um namespace pode abranger vários assemblies e nem todos eles precisam ser carregados ao mesmo tempo.

O compilador processará qualquer marca que seja um XML válido. As seguintes marcas fornecem as funcionalidades geralmente usadas na documentação do usuário.

• <c>
• <code>
• <example>
• <exception>¹
• <include>¹
• <list>
• <para>
• <param>¹
• <paramref>
• <permission>¹
• <remarks>
• <returns>
• <see>¹
• <seealso>¹
• <summary>
• <typeparam>¹
• <value>

(¹ O compilador verifica a sintaxe.)

Observação

Se você quiser que sejam exibidos colchetes angulares no texto de um comentário de documentação, use < e >. Por exemplo, a cadeia de caracteres "<text in angle brackets>" será exibida como <text in angle brackets>.

Confira também

• Documentando o código com XML
• -doc
• Como criar documentação XML