<list> (Visual Basic)

Definiuje listę lub tabelę.

Składnia

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

Parametry

type
Typ listy. Musi być punktorem dla listy punktowanej, "number" dla listy numerowanej lub "table" dla tabeli dwukolumna.

term
Używane tylko wtedy, gdy type jest "tabela". Termin do zdefiniowania, który jest zdefiniowany w tagu opisu.

description
Gdy type wartość to "bullet" lub "number" description , jest elementem na liście Gdy type jest "tabela" description , jest definicją term.

Uwagi

Blok <listheader> definiuje nagłówek tabeli lub listy definicji. Podczas definiowania tabeli wystarczy podać wpis w term nagłówku.

Każdy element na liście jest określony z blokiem <item> . Podczas tworzenia listy definicji należy określić wartości i termdescription. Jednak w przypadku tabeli, listy punktowanej lub listy numerowanej wystarczy podać wpis dla descriptionelementu .

Lista lub tabela może zawierać tyle <item> bloków, ile jest potrzebnych.

Skompiluj za pomocą -doc , aby przetworzyć komentarze dokumentacji do pliku.

Przykład

W tym przykładzie użyto tagu <list> do zdefiniowania listy punktowanej w sekcji uwagi.

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

Zobacz też

• Tagi komentarza XML