Udostępnij za pośrednictwem

<summary> (Visual Basic)

  • Artykuł

Określa krótki opis elementu członkowskiego.

<summary>description</summary>

Parametry

  • description
    Krótki opis obiektu.

Uwagi

Użycie <summary> tag do opisu typu lub członka typu.Użycie <remarks> (Visual Basic) Aby dodać informacje uzupełniające do opisu typu.

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

Kompilacji z /doc do procesu dokumentacji komentarze do pliku.

Przykład

W poniższym przykładzie użyto <summary> tag, aby opisać ResetCounter metoda i Counter właściwość.

''' <summary>
''' Resets the value 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ż

Informacje

Zalecane tagów XML dla komentarzy dokumentacji (Visual Basic)