<esempio> (Visual Basic)

Specifica un esempio per il membro.

Sintassi

<example>description</example>  

Parametri

description
Descrizione dell'esempio di codice.

Osservazioni:

Il tag <example> consente di specificare un esempio di come usare un metodo o un altro membro della libreria. Questo comporta in genere l'uso del tag di <codice> .

Compilare con -doc per elaborare i commenti della documentazione in un file.

Esempio

In questo esempio viene usato il <example> tag per includere un esempio per l'uso del 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

Vedere anche

• Tag di commento XML