Compartir a través de

<example> (Visual Basic)

  • Artículo

Especifica un ejemplo para el miembro.

<example>description</example>

Parámetros

  • description
    Descripción del ejemplo de código.

Comentarios

La etiqueta <example> permite especificar un ejemplo de cómo utilizar un método u otro miembro de una biblioteca. Generalmente, esto supone utilizar la etiqueta <code> (Visual Basic).

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

Ejemplo

Este ejemplo utiliza la etiqueta <example> para incluir un ejemplo de utilización del 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

Vea también

Referencia

Etiquetas XML recomendadas para comentarios de documentación (Visual Basic)