Sdílet prostřednictvím

<summary> (Visual Basic)

  • Článek

Určuje souhrn člena.

<summary>description</summary>

Parametry

  • description
    Souhrn objektu.

Poznámky

Použití <summary> značek popisují typ nebo člen typu.Použití <remarks> (Visual Basic) popis typu přidat doplňující informace.

Text <summary> je jediným zdrojem informací o typu IntelliSense značku a také je zobrazena v prohlížeči objektů.Informace o prohlížeči objektů, Zobrazení struktury kódu.

Kompilace s /doc k procesu dokumentační komentáře do souboru.

Příklad

V tomto příkladu <summary> značek popisují ResetCounter metody a Counter vlastnost.

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

Viz také

Referenční dokumentace

Doporučené značky XML pro komentáře k dokumentaci (Visual Basic)