Поделиться через

<list> (Visual Basic)

  • Статья

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

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

Параметры

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

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

  • description
    Если тип type — "bullet" или "number", то description — это элемент списка. Если type — "table", то 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

См. также

Ссылки

Рекомендуется использовать XML-теги для комментариев документации (Visual Basic)