<list> (Visual Basic)

  • Artículo

Define una lista o una 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 "bullet" para una lista con viñetas, "number" para una lista numerada o "table" para una tabla de dos columnas.

term
Solo se usa cuando type es "table". Un término que se va a definir, que se define en la etiqueta de la 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, solo es necesario proporcionar 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, es necesario especificar tanto term como description. En cambio, para una tabla, una lista con viñetas o una lista numerada, solo es necesario suministrar 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 de un archivo.

Ejemplo

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

Consulte también