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

<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.Use el atributo cref para que herramientas de documentación como Sandcastle puedan crear hipervínculos internos a las páginas de documentación de los elementos de código.

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 Object Browser Window.

Compile con el parámetro /doc para procesar los comentarios de documentación y generar un archivo con ellos.Para crear la documentación final basándose en el archivo generado por el compilador, se puede crear una herramienta personalizada o usar una herramienta como Sandcastle.

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

En el ejemplo anterior, se produce el siguiente archivo XML.

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>YourNamespace</name>
    </assembly>
    <members>
        <member name="T:DotNetEvents.TestClass">
            text for class TestClass
        </member>
        <member name="M:DotNetEvents.TestClass.DoWork(System.Int32)">
            <summary>DoWork is a method in the TestClass class.
            <para>Here's how you could make a second paragraph in a description. <see cref="M:System.Console.WriteLine(System.String)"/> for information about output statements.</para>
            <seealso cref="M:DotNetEvents.TestClass.Main"/>
            </summary>
        </member>
        <member name="M:DotNetEvents.TestClass.Main">
            text for Main
        </member>
    </members>
</doc>

El ejemplo siguiente muestra cómo convertir una referencia cref en un tipo genérico.

// compile with: /doc:DocFileName.xml 

// the following cref shows how to specify the reference, such that,
// the compiler will resolve the reference
/// <summary cref="C{T}">
/// </summary>
class A { }

// the following cref shows another way to specify the reference, 
// such that, the compiler will resolve the reference
// <summary cref="C &lt; T &gt;">

// the following cref shows how to hard-code the reference
/// <summary cref="T:C`1">
/// </summary>
class B { }

/// <summary cref="A">
/// </summary>
/// <typeparam name="T"></typeparam>
class C<T> { }

En el ejemplo anterior, se produce el siguiente archivo XML.

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>YourNamespace</name>
    </assembly>
    <members>
        <member name="T:ExtensionMethodsDemo1.A">
            <summary cref="T:ExtensionMethodsDemo1.C`1">
            </summary>
        </member>
        <member name="T:ExtensionMethodsDemo1.B">
            <summary cref="T:C`1">
            </summary>
        </member>
        <member name="T:ExtensionMethodsDemo1.C`1">
            <summary cref="T:ExtensionMethodsDemo1.A">
            </summary>
            <typeparam name="T"></typeparam>
        </member>
    </members>
</doc>

Vea también

Referencia

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

Conceptos

Guía de programación de C#