Compartir a través de

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

  • Artículo

Actualización: noviembre 2007

<summary>description</summary>

Parámetros

  • description
    Resumen del objeto.

Comentarios

La etiqueta <summary> se utiliza para describir un tipo o un miembro de tipo. Utilice <remarks> para suministrar información adicional a una descripción de tipo.

El texto de la etiqueta <summary> es la única fuente de información sobre el tipo en IntelliSense y tambié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 

/// text for class TestClass
public class TestClass
{
    /// <summary>DoWork is a method in the TestClass class.
    /// <para>Here's how you could make a second paragraph in a description. <see cref="System.Console.WriteLine(System.String)"/> for information about output statements.</para>
    /// <seealso cref="TestClass.Main"/>
    /// </summary>
    public static void DoWork(int Int1)
    {
    }

    /// 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#)