Sdílet prostřednictvím

<summary> (Visual Basic)

  • Článek

Určuje souhrn člena.

Syntaxe

<summary>description</summary>

Parametry

description
Souhrn objektu.

Poznámky

<summary> Značka slouží k popisu typu nebo člena typu. Poznámky slouží <k přidání doplňkových> informací do popisu typu.

Text značky <summary> je jediným zdrojem informací o typu v IntelliSense a zobrazuje se také v prohlížeči objektů. Informace o prohlížeči objektů naleznete v tématu Zobrazení struktury kódu.

Zkompilujte pomocí -doc a zpracujte komentáře dokumentace k souboru.

Příklad

Tento příklad používá <summary> značku k popisu ResetCounter metody a Counter vlastnosti.

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

Viz také