Condividi tramite

<example> (Visual Basic)

  • Articolo

Specifica un esempio per il membro.

<example>description</example>

Parametri

  • description
    Descrizione dell'esempio di codice.

Note

Il tag <example> consente di specificare un esempio relativo all'utilizzo di un metodo o di un altro membro della libreria. Questo presuppone generalmente l'utilizzo del tag <code> (Visual Basic).

Eseguire la compilazione con /doc per elaborare in un file i commenti relativi alla documentazione.

Esempio

Nell'esempio riportato di seguito il tag <example> viene utilizzato per includere un esempio relativo all'utilizzo 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

Vedere anche

Riferimenti

Tag XML consigliati per i commenti relativi alla documentazione (Visual Basic)