<example> (Visual Basic)

  • Artigo

Especifica um exemplo do membro.

Sintaxe

<example>description</example>

Parâmetros

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

Comentários

A marca <example> permite especificar um exemplo de como usar um método ou outro membro da biblioteca. Normalmente, isso envolve o uso da marca <code>.

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

Exemplo

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

Confira também