Share via

<list> (Visual Basic)

  • Artikel

Definiert eine Liste oder Tabelle.

<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 bei Aufzählungen "bullet" sein, "number" bei nummerierten Listen und "table" bei zweispaltigen Tabellen.

  • term
    Nur verwendet, wenn type den Wert "table" hat. Ein zu definierender Begriff, der im Beschreibungstag definiert wird.

  • description
    Wenn type den Wert "bullet" oder "number" hat, ist description ein Element in der Liste. Wenn type den Wert "table" hat, ist description die Definition von term.

Hinweise

Der <listheader>-Block wird zur Definition der Überschrift einer Tabelle oder einer Definitionsliste verwendet. Beim Definieren einer Tabelle muss in der Überschrift lediglich ein Eintrag für term angegeben werden.

Jedes Element der Liste wird mit einem <item>-Block angegeben. Wenn Sie eine Definitionsliste erstellen, 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 beliebig viele <item>-Blöcke enthalten.

Dokumentationskommentare werden zu einer Datei verarbeitet, indem sie mit /doc kompiliert werden.

Beispiel

Im folgenden Beispiel wird mit dem <list>-Tag im Hinweisabschnitt eine Aufzählung definiert.

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

Referenz

Empfohlene XML-Tags für Dokumentationskommentare (Visual Basic)