Recomendado marcas de comentários de documentação (C# guia de programação)

O compilador C# processa os comentários de documentação no seu código e as formata como XML em um arquivo cujo nome que você especificar o /doc opção de linha de comando. Para criar a documentação final com base no arquivo gerado pelo compilador, você pode criar uma ferramenta personalizada ou usar uma ferramenta como Sandcastle.

As marcas são processadas em construções de código como, por exemplo, tipos e digitar os membros.

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

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

Marcas

<c>	<para>	<see>*
<código>	<param>*	<seealso>*
<example>	<paramref>	<summary>
<exception>*	<permission>*	<typeparam>*
<include>*	<remarks>	<typeparamref>
<list>	<returns>	<value>

(* indica que o compilador verifica a sintaxe.)

Se você quiser colchetes angulares apareçam no texto de um comentário de documentação, use < e >, conforme mostrado no exemplo a seguir.

/// <summary cref="C &lt; T &gt;">

Consulte também

Referência

/doc ( Opçõesdo compilador TRANSLATION FROM VPE FOR CSHARP)

XML Documentation Comments (C# Programming Guide)

Conceitos

C# Programming Guide