<пример> (Visual Basic)

  • Статья

Указывает пример элемента.

Синтаксис

<example>description</example>

Параметры

description
Описание примера кода.

Замечания

Тег <example> позволяет указать пример использования метода или другого элемента библиотеки. Это обычно включает использование тега <кода> .

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

Пример

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

Public Class Employee
    ''' <remarks>
    ''' <example> This sample shows how to set the <c>ID</c> field.
    ''' <code>
    ''' Dim alice As New Employee
    ''' alice.ID = 1234
    ''' </code>
    ''' </example>
    ''' </remarks>
    Public ID As Integer
End Class

См. также