<ejemplo> (Visual Basic)

Especifica un ejemplo para el miembro.

Sintaxis

<example>description</example>  

Parámetros

description
Descripción del ejemplo de código.

Observaciones

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

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

Ejemplo

En este ejemplo se usa la <example> etiqueta para incluir un ejemplo para usar el ID campo .

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

• Etiquetas de comentario XML