<example> (Visual Basic)

  • Artículo

Especifica un ejemplo para el miembro.

Sintaxis

<example>description</example>

Parámetros

description
Una descripción del ejemplo de código.

Comentarios

La etiqueta <example> le permite especificar un ejemplo de cómo usar un método u otro miembro de biblioteca. Esto normalmente implica el uso de la etiqueta <code>.

Compile con -doc para procesar los comentarios de documentación de un archivo.

Ejemplo

En este ejemplo se usa la etiqueta <example> para incluir un ejemplo a fin de usar el campo 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

Consulte también