<list> (Visual Basic)

  • Artigo

Define uma lista ou tabela.

Sintaxe

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

Parâmetros

type
O tipo da lista. Deve ser um "marcador" para uma lista com marcadores, "número" para uma lista numerada ou "tabela" para uma tabela de duas colunas.

term
Usado somente quando type é "tabela". Um termo a ser definido, que é definido na marca de descrição.

description
Quando type é "marcador" ou "número", description é um item na lista Quando type é "tabela", description é a definição de term.

Comentários

O bloco <listheader> define o título de uma tabela ou lista de definições. Ao definir uma tabela, é necessário fornecer uma entrada para term no título.

Cada item na lista é especificado com um bloco <item>. Ao criar uma lista de definições, é necessário especificar term e description. No entanto, para uma tabela, lista com marcadores ou lista numerada, será necessário fornecer apenas uma entrada para description.

Uma lista ou tabela pode ter quantos blocos <item> forem necessários.

Compile com -doc para processar comentários de documentação em um arquivo.

Exemplo

Este exemplo usa a marca <list> para definir uma lista com marcadores na seção de comentários.

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

Confira também