Partilhar via


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

<remarks>description</remarks>

Parâmetros

  • Description
    Uma descrição do membro.

Comentários

O <remarks> marca é usada para adicionar informações sobre um tipo, complementando as informações especificadas com <summary>. Essas informações são exibidas na Object Browser Window.

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

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

Conceitos

Guia de Programação em C#