<resumen> (Visual Basic)

  • Artículo

Especifica el resumen del miembro.

Sintaxis

<summary>description</summary>

Parámetros

description
Resumen del objeto.

Comentarios

Usa la etiqueta <summary> para describir un tipo o un miembro de tipo. Use <remarks> para agregar información adicional a una descripción de tipo.

El texto de la etiqueta <summary> es la única fuente de información sobre el tipo en IntelliSense, y también se muestra en el Examinador de objetos. Para más información sobre el Examinador de objetos, consulte Ver la estructura del código.

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

Ejemplo

En este ejemplo se usa la etiqueta <summary> para describir el método ResetCounter y 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