Marcas recomendadas para comentários de documentação (Guia de Programação em C#)

O compilador C# processa os comentários de documentação no seu código e formatar-los como XML em um arquivo cujo nome você especifique a opção de linha de comando de /doc . Para criar documentação final com base no arquivo compilador-geradas, você pode criar uma ferramenta personalizada, ou usar uma ferramenta como Castelo de confiança.

As marcas são processadas em construções de código como tipos e membros do tipo.

Dica

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

O compilador processará qualquer marca que é XML válido. As seguintes marcas fornecem funcionalidades comumente 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ê deseja que os colchetes angulares sejam exibido no texto da documentação, use < e >, conforme mostrado no exemplo o seguir.

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

Consulte também

Referência

/doc (opções do compilador C#)

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

Conceitos

Guia de Programação em C#