Compartilhar via

<list> (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 obter uma lista com marcadores, "número" para uma lista numerada ou "tabela" para uma tabela de coluna de-dois.

  • term
    Apenas usada quando 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 é "table", descriptioné a definição de term.

Comentários

O <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. Ao criar uma lista de definições, você deve especificar ambos term e description. No entanto, para uma tabela, uma lista com marcadoresou uma lista numerada, você só precisa fornecer uma entrada para description.

Uma lista ou tabela pode ter quantos <item> bloqueia conforme necessário.

Compile with /doc to process documentation comments to a file.

Exemplo

Este exemplo usa a <list> a marca 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

Consulte também

Referência

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