Partilhar via

<remarks> (Guia de programação C#)

  • Artigo
<remarks>description</remarks>

Parâmetros

  • Description
    Uma descrição do membro.

Comentários

<remarks> marca é usada para adicionar informações sobre um tipo, complementando as informações especificadas com <summary>. Essa informação é exibida na Pesquisador de Objetos.

Compilar com /doc a comentários de documentação do processo para um arquivo.

Exemplo

// compile with: /doc:DocFileName.xml 

/// <summary>
/// You may have some primary information about this class.
/// </summary>
/// <remarks>
/// You may have some additional information about this class.
/// </remarks>
public class TestClass
{
    /// text for Main
    static void Main()
    {
    }
}

Consulte também

Referência

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

Conceitos

C# Programming Guide