<example> (Visual Basic)

Określa przykład elementu członkowskiego.

Składnia

<example>description</example>  

Parametry

description
Opis przykładowego kodu.

Uwagi

Tag <example> umożliwia określenie przykładu użycia metody lub innego elementu członkowskiego biblioteki. Często wiąże się to z użyciem tagu <kodu> .

Skompiluj za pomocą -doc , aby przetworzyć komentarze dokumentacji do pliku.

Przykład

W tym przykładzie użyto tagu <example> do uwzględnienia przykładu ID użycia pola.

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

Zobacz też

• Tagi komentarza XML