Compartir a través de

<remarks> (Guía de programación de C#)

  • Artículo

Actualización: noviembre 2007

<remarks>description</remarks>

Parámetros

  • Description
    Descripción del miembro.

Comentarios

La etiqueta <remarks> se utiliza para agregar información sobre un tipo, de modo que completa la información especificada con <summary>. Esta información se muestra en el Examinador de objetos.

Compile con el parámetro /doc para procesar los comentarios de documentación y generar un archivo con ellos.

Ejemplo

// 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()
    {
    }
}

Vea también

Conceptos

Guía de programación de C#

Referencia

Etiquetas recomendadas para comentarios de documentación (Guía de programación de C#)