Compartir a través de

<value> (Visual Basic)

  • Artículo

Especifica la descripción de una propiedad.

Sintaxis

<value>property-description</value>

Parámetros

property-description
Una descripción de la propiedad.

Comentarios

Use la etiqueta <value> para describir una propiedad. Tenga en cuenta que cuando agrega una propiedad mediante un asistente de código en el entorno de desarrollo de Visual Studio, agregará una etiqueta <summary> para la nueva propiedad. Después, debe agregar manualmente una etiqueta <value> para describir el valor que representa esa propiedad.

Compile con -doc para procesar los comentarios de documentación de un archivo.

Ejemplo

En este ejemplo se usa la etiqueta <value> para describir qué valor contiene la propiedad Counter.

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

Consulte también