Compartilhar via

<lista>(Visual Basic)

  • Artigo

Define uma lista ou tabela.

<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 de 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 quando apenas typeé "tabela". Um termo para definir, 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

The <listheader> bloco define o título de uma tabela ou uma definição de lista. Ao definir uma tabela, você só precisa fornecer uma entrada para term no título.

Cada item da lista é especificado com um <item> bloco. Quando criando uma definição de lista, você deve especificar ambas term e description. No entanto, para uma tabela, lista com marcadores ou lista numerada, você só precisa fornecer uma entrada para description.

Uma lista ou tabela pode ter tantas <item> blocos conforme necessário.

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

Exemplo

Este exemplo usa o <list> marca a definir uma lista com marcadores na seção 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

Consulte também

Referência

Recomendado marcas XML para comentários da documentação (Visual Basic)