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

<list type="bullet" | "number" | "table">
    <listheader>
        <term>term</term>
        <description>description</description>
    </listheader>
    <item>
        <term>term</term>
        <description>description</description>
    </item>
</list>

Parámetros

• term
  Término que se define en description.

• description
  Elemento de una lista numerada o con viñetas, o definición de un term.

Comentarios

El bloque <listheader> se utiliza para definir la fila de encabezado de una tabla o de una lista de definiciones.Cuando se define una tabla, sólo es necesario suministrar una entrada para un término en el encabezado.

Cada elemento de la lista se especifica con un bloque <item>.Cuando se crea una lista de definiciones, se deberán especificar tanto term como description.Sin embargo, para una tabla, lista con viñetas o lista numerada, sólo es necesario suministrar una entrada para description.

Una lista o una tabla pueden tener tantos bloques <item> como sean necesarios.

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>Here is an example of a bulleted list:
    /// <list type="bullet">
    /// <item>
    /// <description>Item 1.</description>
    /// </item>
    /// <item>
    /// <description>Item 2.</description>
    /// </item>
    /// </list>
    /// </summary>
    static void Main()
    {
    }
}

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#