Compartilhar via

Recomendado Rótulos de comentários de documentação (guia de programação translation from VPE for Csharp)

  • Artigo

O compilador translation from VPE for Csharp será processo comentários da documentação em seu código para um arquivo XML.O arquivo XML para criar documentação de processamento é um detalhe que precisa ser implementada no seu site.

sistema autônomo Rótulos são processadas em construções de código, sistema autônomo tipos e digite membros.

Observação:

Comentários de documentação não podem ser aplicados a um namespace.

O compilador irá processar qualquer marca é um XML válido.As seguintes Rótulos fornecem funcionalidade geralmente usada na documentação do usuário.

Rótulos

<c>

<para>

<see>*

<código>

<param>*

<seealso>*

<example>

<paramref>

<summary>

<exceção>*

<permissão>*

<typeparam>*

<include>*

<remarks>

<typeparamref>

<list>

<returns>

<value>

(* indica que o compilador verifica sintaxe.)

Se você quiser colchetes angulares seja exibido o texto de um comentário de documentação, use &amplt; e &ampgt;.Por exemplo, &amplt; texto em colchetes angulares &ampgt;.

Consulte também

Tarefas

Exemplo de documentação XML

Conceitos

Guia de Programação C#

Referência

/doc (processo Documentação Comments) (opções do compilador de C#)

Comentários de documentação XML (Guia de programação C#)