<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>
Parameter
type
Der Typ der Liste. Muss „Bullet“ (Aufzählungszeichen) für eine Aufzählung, „number“ (Zahl) für eine nummerierte Liste oder „table“ (Tabelle) für eine zweispaltige Tabelle sein.
term
Wird nur verwendet, wenn type „table“ ist. Ein zu definierender Begriff, der im description-Tag definiert wird.
description
Wenn type „bullet“ oder „number“ ist, ist description ein Element in der Liste. Wenn type „table“ ist, ist description die Definition von term.
Bemerkungen
Der <listheader>-Block wird definiert die Überschriftenzeile einer Tabelle oder einer Definitionsliste. Beim Definieren einer Tabelle müssen Sie nur einen Eintrag für term in der Überschrift angeben.
Jedes Element der Liste wird mit einem <item>-Block angegeben. Beim Erstellen einer Definitionsliste müssen Sie sowohl term als auch description angeben. Für eine Tabelle, eine Aufzählung oder eine nummerierte Liste muss jedoch nur ein Eintrag für description angegeben werden.
Eine Liste oder Tabelle kann so viele <item>-Blöcke besitzen wie nötig.
Kompilieren Sie mit -doc, um Dokumentationskommentare zu einer Datei zu verarbeiten.
Beispiel
In diesem Beispiel wird das <list> -Tag verwendet, um eine Aufzählung im Abschnitt „remarks“ (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
