Compartir a través de

<summary> (Visual Basic)

  • Artículo

Especifica el resumen del miembro.

<summary>description</summary>

Parámetros

  • description
    Resumen del objeto.

Comentarios

Utilice la etiqueta <summary> para describir un tipo o un miembro de tipo. Utilice <remarks> (Visual Basic) para suministrar 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 se muestra en el explorador de objetos. Para obtener información sobre el explorador de objetos, vea Ver la estructura del código.

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

Ejemplo

Este ejemplo utiliza la etiqueta <summary> para describir el método ResetCounter y la propiedad Counter.

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

Vea también

Referencia

Etiquetas XML recomendadas para comentarios de documentación (Visual Basic)