Dela via

<sammanfattning> (Visual Basic)

  • Artikel

Anger sammanfattningen av medlemmen.

Syntax

<summary>description</summary>

Parametrar

description
En sammanfattning av objektet.

Kommentarer

Använd taggen <summary> för att beskriva en typ eller en typmedlem. Använd <kommentarer> för att lägga till kompletterande information i en typbeskrivning.

Texten för taggen <summary> är den enda informationskällan om typen i IntelliSense och visas också i Object Browser. Information om objektwebbläsaren finns i Visa kodens struktur.

Kompilera med -doc för att bearbeta dokumentationskommentare till en fil.

Exempel

I det här exemplet används taggen <summary> för att beskriva ResetCounter metoden och Counter egenskapen.

''' <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

Se även