<list> (Visual Basic)

  • Статья

Определяет список или таблицу.

Синтаксис

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

Параметры

type
Тип списка. Должен быть "маркером" для маркированного списка, "число" для нумерованного списка или таблицы для двух столбцов.

term
Используется только в том случае, если type это таблица. Термин для определения, который определяется в теге описания.

description
Если имеет значение "маркер" или "число"description, это элемент в списке", type если type это "таблица"description, является определениемterm.

Замечания

Блок <listheader> определяет заголовок списка таблиц или определений. При определении таблицы необходимо указать только запись term в заголовке.

Каждый элемент в списке указывается в блоке <item>. При создании списка определений необходимо указать оба term и description. Однако для таблицы, маркированного списка или нумерованного списка необходимо указать только запись.description

Число блоков <item> в списке или таблице не ограничено.

Чтобы обработать комментарии документации и сохранить их в файл, выполняйте сборку с параметром -doc.

Пример

В этом примере тег используется <list> для определения маркированного списка в разделе примечаний.

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

См. также