Edit

(Visual Basic)

Specifies an example for the member.

Syntax

description  

Parameters

description
A description of the code sample.

Remarks

The tag lets you specify an example of how to use a method or other library member. This commonly involves using the tag.

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

Example

This example uses the tag to include an example for using the ID field.

Public Class Employee
    ''' 
    '''  This sample shows how to set the ID field.
    ''' 
    ''' Dim alice As New Employee
    ''' alice.ID = 1234
    ''' 
    ''' 
    ''' 
    Public ID As Integer
End Class

See also