<exemplo> (Visual Basic)

Especifica um exemplo para o membro.

Sintaxe

<example>description</example>  

Parâmetros

description
Uma descrição do exemplo de código.

Observações

A <example> tag permite especificar um exemplo de como usar um método ou outro membro da biblioteca. Isso geralmente envolve o uso da <tag de código> .

Compile com -doc para processar comentários de documentação para um arquivo.

Exemplo

Este exemplo usa a <example> tag para incluir um exemplo de uso do 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

Ver também

• Tags de comentário XML