Partilhar via

Recomendado marcas XML para comentários da documentação (Visual Basic)

  • Artigo

O compilador Visual Basic pode processar comentários de documentação em seu código para um arquivo XML.Você pode usar as ferramentas adicionais para processar o arquivo XML em documentação.

Comentários XML são permitidos em construções de código, como tipos e membros de tipos.Para tipos parciais, apenas uma parte do tipo pode ter comentários XM, embora não haja nenhuma restrição em comentar seus membros.

Observação:

Comentários de documentação não pode ser aplicado espaços para nome.O motivo é que um espaço de nomes pode abranger vários conjuntos de módulos (assemblys), e não todos os conjuntos de módulos (assemblys) têm que ser carregados ao mesmo tempo.

O compilador processa qualquer marca que é XML válido.As seguintes marcas fornecem funcionalidades comumente usadas na documentação do usuário.

<c>

<código>

<example>

<exceção>1

<include>1

<list>

<para>

<param>1

<paramref>

<permissão>1

<remarks>

<returns>

<see>1

<seealso>1

<summary>

<typeparam>1

<value>

(1 O compilador verifica a sintaxe.)

Observação:

Se você quiser colchetes angulares seja exibido o texto de um comentário de documentação, use &lt; e &gt;.Por exemplo, a sequência de caracteres "&lt;text in angle brackets&gt;" aparecerá como <text in anglebrackets>.

Consulte também

Tarefas

Como: Criar documentação XML no Visual Basic

Conceitos

Documentando Seu Código com XML (Visual Basic)

Referência

/doc