Org.SourceFlow.VisualBasic
Class VisualBasicComment

IComparable
   |
   +--CodeElement
         |
         +--VisualBasicComment

public class VisualBasicComment

extends CodeElement

A class generating a Visual Basic comment.

Category

public override int Category;

Returns a numeric category number for the code element. A lower category number implies that the code element should be placed before code elements with a higher category number within a declaration.

Returns:

the category number

DOCUMENTATION

public const int DOCUMENTATION;

The documentation comment type. Note that this type may be used even if the comment spans several lines, as the ''' characters will be duplicated for each line.

SINGLELINE

public const int SINGLELINE;

The single line comment type. Note that this type may be used even if the comment spans several lines, as the ' character will be duplicated for each line.

VisualBasicComment

public VisualBasicComment( string comment );

Creates a new documentation comment with no indentation.

Parameters:

comment - the comment text

VisualBasicComment

public VisualBasicComment( int type, string comment );

Creates a new comment of the specified type.

Parameters:

type - the comment type

comment - the comment text

See Also:

DOCUMENTATION, SINGLELINE

Print

public override void Print( StreamWriter output, CodeStyle style, int indent );

Prints the comment to the specified stream.

Parameters:

output - the output stream

style - the code style to use

indent - the indentation level