Marcas recomendadas para comentários deC# documentação (guia de programação)Recommended tags for documentation comments (C# programming guide)

O compilador do C# processa comentários de documentação em seu código e os formata como XML em um arquivo, cujo nome você especifica na opção de linha de comando /doc.The C# compiler processes documentation comments in your code and formats them as XML in a file whose name you specify in the /doc command-line option. Para criar a documentação final com base no arquivo gerado pelo compilador, crie uma ferramenta personalizada ou use uma ferramenta como o DocFX ou o Sandcastle.To create the final documentation based on the compiler-generated file, you can create a custom tool, or use a tool such as DocFX or Sandcastle.

As marcas são processadas em constructos de código, como tipos e membros de tipo.Tags are processed on code constructs such as types and type members.

Observação

Os comentários de documentação não podem ser aplicados a um namespace.Documentation comments cannot be applied to a namespace.

O compilador processará qualquer marca que seja um XML válido.The compiler will process any tag that is valid XML. As seguintes marcas fornecem as funcionalidades geralmente usadas na documentação do usuário.The following tags provide generally used functionality in user documentation.

MarcasTags

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

(* indica que o compilador verifica a sintaxe.)(* denotes that the compiler verifies syntax.)

Se você quiser que os colchetes angulares sejam exibidos no texto de um comentário de documentação, use a codificação HTML de < e >, que são &lt; e &gt; respectivamente.If you want angle brackets to appear in the text of a documentation comment, use the HTML encoding of < and > which is &lt; and &gt; respectively. Essa codificação é mostrada no exemplo a seguir.This encoding is shown in the following example.

/// <summary>
/// This property always returns a value &lt; 1.
/// </summary>

Veja tambémSee also