Delen via

<samenvatting> (Visual Basic)

  • Artikel

Hiermee geeft u de samenvatting van het lid.

Syntaxis

<summary>description</summary>

Parameters

description
Een samenvatting van het object.

Opmerkingen

Gebruik de <summary> tag om een type of een typelid te beschrijven. Gebruik <opmerkingen> om aanvullende informatie toe te voegen aan een typebeschrijving.

De tekst voor de <summary> tag is de enige bron van informatie over het type in IntelliSense en wordt ook weergegeven in de objectbrowser. Zie De structuur van code bekijken voor meer informatie over de objectbrowser.

Compileer met -doc om documentatieopmerkingen naar een bestand te verwerken.

Opmerking

In dit voorbeeld wordt de <summary> tag gebruikt om de ResetCounter methode en Counter eigenschap te beschrijven.

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

Zie ook