Udostępnij za pośrednictwem

<summary> (Visual Basic)

  • Artykuł

Określa podsumowanie elementu członkowskiego.

Składnia

<summary>description</summary>

Parametry

description
Podsumowanie obiektu.

Uwagi

Użyj tagu, <summary> aby opisać typ lub element członkowski typu. Użyj <uwag> , aby dodać informacje uzupełniające do opisu typu.

Tekst tagu <summary> jest jedynym źródłem informacji o typie w funkcji IntelliSense i jest również wyświetlany w przeglądarce obiektów. Aby uzyskać informacje o przeglądarce obiektów, zobacz Wyświetlanie struktury kodu.

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

Przykład

W tym przykładzie użyto tagu <summary> do opisania ResetCounter metody i Counter właściwości.

''' <summary>
''' Resets the value of the <c>Counter</c> field.
''' </summary>
Public Sub ResetCounter()
    counterValue = 0
End Sub
Private counterValue As Integer = 0
''' <summary>
''' Returns the number of times Counter was called.
''' </summary>
''' <value>Number of times Counter was called.</value>
Public ReadOnly Property Counter() As Integer
    Get
        counterValue += 1
        Return counterValue
    End Get
End Property

Zobacz też