<summary> (Visual Basic)

  • Article

Specifies the summary of the member.

<summary>description</summary>

Parameters

  • description
    A summary of the object.

Remarks

Use the <summary> tag to describe a type or a type member. Use <remarks> (Visual Basic) to add supplemental information to a type description.

The text for the <summary> tag is the only source of information about the type in IntelliSense, and is also displayed in the Object Browser.

Compile with /doc to process documentation comments to a file.

Example

This example uses the <summary> tag to describe the ResetCounter method and Counter property.

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

See Also

Reference

Recommended XML Tags for Documentation Comments (Visual Basic)