<összefoglalás> (Visual Basic)

A tag összegzését adja meg.

Szemantika

<summary>description</summary>  

Paraméterek

description
Az objektum összegzése.

Megjegyzések

A címke egy <summary> típus vagy egy típustag leírására használható. Megjegyzésekkel <> kiegészítő információkat adhat hozzá egy típusleíráshoz.

A címke szövege <summary> az egyetlen információforrás az IntelliSense típusáról, és az Object Browserben is megjelenik. Az Object Browserről további információt a Kód szerkezetének megtekintése című témakörben talál.

Fordítás -doc használatával egy fájl dokumentációs megjegyzéseinek feldolgozásához.

példa

Ez a példa a <summary> címke használatával írja le a metódust és Counter a ResetCounter tulajdonságot.

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

Lásd még

• XML-megjegyzéscímkék