<list> (Visual Basic)
Definuje seznam nebo tabulku.
Syntaxe
<list type="type">
<listheader>
<term>term</term>
<description>description</description>
</listheader>
<item>
<term>term</term>
<description>description</description>
</item>
</list>
Parametry
type
Typ seznamu. Musí to být odrážka pro seznam s odrážkami, číslo pro číslovaný seznam nebo tabulka pro tabulku se dvěma sloupci.
term
Používá se pouze v případech, kdy type
je tabulka. Termín, který se definuje ve značce popisu.
description
Pokud type
je "odrážka" nebo "číslo", description
je položka v seznamu Když type
je "tabulka", description
je definice term
.
Poznámky
Blok <listheader>
definuje nadpis tabulky nebo seznamu definic. Při definování tabulky stačí zadat pouze položku v term
záhlaví.
Každá položka v seznamu je určena blokem <item>
. Při vytváření seznamu definic je nutné zadat obě term
a description
. Pro tabulku, seznam s odrážkami nebo číslovaný seznam však musíte zadat pouze položku pro description
.
Seznam nebo tabulka můžou mít libovolný počet <item>
bloků.
Zkompilujte pomocí -doc a zpracujte komentáře dokumentace k souboru.
Příklad
Tento příklad používá <list>
značku k definování seznamu s odrážkami v oddílu poznámek.
''' <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