<list> (Visual Basic)

Definiert eine Liste oder Tabelle.

Syntax

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

Die Parameter

type
Der Typ der Liste. Muss ein "Aufzählungszeichen" für eine Aufzählung, "Zahl" für eine nummerierte Liste oder "Tabelle" für eine zweispaltige Tabelle sein.

term
Wird nur verwendet, wenn type es sich um "Tabelle" handelt. Ein zu definierener Ausdruck, der im Beschreibungstag definiert ist.

description
Wenn type es sich um "Aufzählungszeichen" oder "Zahl" description handelt, handelt es sich um ein Element in der Liste "Tabelle type " description , ist die Definition von term.

Bemerkungen

Der <listheader> Block definiert die Überschrift einer Tabelle oder Einer Definitionsliste. Beim Definieren einer Tabelle müssen Sie nur einen Eintrag für term die Überschrift angeben.

Jedes Element der Liste wird mit einem <item>-Block angegeben. Beim Erstellen einer Definitionsliste müssen Sie sowohl als descriptionauch term . Für eine Tabelle, eine Aufzählung oder eine nummerierte Liste müssen Sie jedoch nur einen Eintrag angeben description.

Eine Liste oder Tabelle kann so viele <item>-Blöcke besitzen wie nötig.

Kompilieren Sie mit -doc , um Dokumentationskommentare in einer Datei zu verarbeiten.

Beispiel

In diesem Beispiel wird das <list> Tag verwendet, um eine Aufzählung im Abschnitt "Hinweise" zu definieren.

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

Siehe auch

• XML-Kommentartags