Dela via

<värde> (Visual Basic)

  • Artikel

Anger beskrivningen av en egenskap.

Syntax

<value>property-description</value>

Parametrar

property-description
En beskrivning av egenskapen.

Kommentarer

Använd taggen <value> för att beskriva en egenskap. Observera att när du lägger till en egenskap med hjälp av kodguiden i Visual Studio-utvecklingsmiljön kommer den att lägga till en <sammanfattningstagg> för den nya egenskapen. Du bör sedan lägga till en <value> tagg manuellt för att beskriva värdet som egenskapen representerar.

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

Exempel

I det här exemplet används taggen <value> för att beskriva vilket värde egenskapen Counter har.

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