<list> (Visual Basic)

Define una lista o tabla.

Sintaxis

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

Parámetros

type
Tipo de la lista. Debe ser una "viñeta" para una lista con viñetas, "número" para una lista numerada o "tabla" para una tabla de dos columnas.

term
Solo se usa cuando type es "table". Término que se va a definir, que se define en la etiqueta description.

description
Cuando type es "viñeta" o "número", description es un elemento de la lista Cuando type es "tabla", description es la definición de term.

Observaciones

El <listheader> bloque define el encabezado de una tabla o una lista de definiciones. Al definir una tabla, solo tiene que proporcionar una entrada para term en el encabezado.

Cada elemento de la lista se especifica con un bloque <item>. Al crear una lista de definiciones, debe especificar y termdescription. Sin embargo, para una tabla, una lista con viñetas o una lista numerada, solo tiene que proporcionar una entrada para description.

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

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

Ejemplo

En este ejemplo se usa la <list> etiqueta 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

Consulte también

• Etiquetas de comentario XML