<example> (Visual Basic)

  • Artigo

Especifica um exemplo para o membro.

<example>description</example>

Parâmetros

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

Comentários

A marca <example> permite que você especifique um exemplo de como usar um método ou outro membro da biblioteca.Isso normalmente envolve usar a marca <code> (Visual Basic).

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

Exemplo

Este exemplo usa a marca <example> para incluir um exemplo para usar o 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 também

Referência

Recomendado marcas XML para comentários da documentação (Visual Basic)