<example> (Visual Basic)

Określa przykład dla elementu członkowskiego.

<example>description</example>

Parametry

  • description
    Opis przykładowy kod.

Uwagi

<example> Tag pozwala na określenie przykładem sposobu użycia metody lub innego członka biblioteki.Obejmuje to powszechnie, za pomocą <code> (Visual Basic) tag.

Kompiluj z /doc do procesu komentarzy dokumentacji do pliku.

Przykład

W tym przykładzie użyto <example> tag, aby dołączyć na przykład za pomocą ID 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ż

Informacje

Zalecane tagi XML dla komentarzy dokumentacji (Visual Basic)