<list> (Visual Basic)

Actualización: noviembre 2007

Define una lista o una tabla.

<list type="type">
   <listheader>
      <term>term</term>
      <description>description</description>
   </listheader>
   <item>
      <term>term</term>
      <description>description</description>
   </item>
</list>

Parámetros

• type
  El tipo de la lista. Debe ser "bullet" para una lista con viñetas, "number" para una lista numerada o "table" para una tabla de dos columnas.

• term
  Sólo se usa cuando type es "table". El término que se define, que lo hace en la etiqueta descripción.

• description
  Cuando type es "bullet" o "number", description es un elemento de la lista. Cuando type es "table", description es la definición de term.

Comentarios

El bloque <listheader> define el encabezado de una tabla o de una lista de definiciones. Cuando se define una tabla, se debe suministrar únicamente una entrada para term en el encabezado.

Cada elemento de la lista se especifica con un bloque <item>. Cuando se crea una lista de definiciones, se debe especificar tanto term como description. Sin embargo, para una tabla, lista con viñetas o lista numerada, se debe suministrar únicamente una entrada para description.

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

Compile con /doc para procesar los comentarios de documentación en un archivo.

Ejemplo

Este ejemplo utiliza la etiqueta <list> para definir una lista con viñetas en la sección de comentarios.

''' <remarks>Before calling the <c>Reset</c> method, be sure to:
''' <list type="bullet">
''' <item><description>Close all connections.</description></item>
''' <item><description>Save the object state.</description></item>
''' </list>
''' </remarks>
Public Sub Reset()
    ' Code goes here.
End Sub

Vea también

Referencia

Etiquetas XML recomendadas para comentarios de documentación (Visual Basic)