Dela via


<lista> (Visual Basic)

Definierar en lista eller tabell.

Syntax

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

Parametrar

type
Typ av lista. Måste vara en punkt för en punktlista, "nummer" för en numrerad lista eller "tabell" för en tabell med två kolumner.

term
Används endast när type är "tabell". En term som ska definieras, som definieras i beskrivningstaggen.

description
När type är "bullet" eller "number" description är ett objekt i listan När type är "tabell" description är definitionen av term.

Kommentarer

Blocket <listheader> definierar rubriken för antingen en tabell eller en definitionslista. När du definierar en tabell behöver du bara ange en post för term i rubriken.

Varje objekt i listan anges med ett <item> block. När du skapar en definitionslista måste du ange både term och description. För en tabell, punktlista eller numrerad lista behöver du dock bara ange en post för description.

En lista eller tabell kan ha så många <item> block som behövs.

Kompilera med -doc för att bearbeta dokumentationskommentare till en fil.

Exempel

I det här exemplet används taggen <list> för att definiera en punktlista i kommentarsavsnittet.

''' <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

Se även