(Visual Basic)

This information appears in the Object Browser. For information about the Object Browser, see Viewing the Structure of Code.

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

Example

This example uses the tag to explain what the UpdateRecord method does.

''' The ID of the record to update.
''' Updates the record .
''' Use  to verify that
''' the record exists before calling this method.
''' 
Public Sub UpdateRecord(ByVal id As Integer)
    ' Code goes here.
End Sub
''' The ID of the record to check.
''' True if  exists,
''' False otherwise.
''' 
Public Function DoesRecordExist(ByVal id As Integer) As Boolean
    ' Code goes here.
End Function

See also

• XML Comment Tags