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

<example> (Visual Basic)

  • Статья

Задает пример для элемента.

<example>description</example>

Параметры

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

Заметки

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

Чтобы выделить документирующие комментарии в отдельный файл, необходимо использовать при компиляции параметр /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

См. также

Ссылки

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