Org.SourceFlow.CSharp
Class CSharpComment

IComparable
   |
   +--CodeElement
         |
         +--CSharpComment

public class CSharpComment

extends CodeElement

A class generating a C# comment.

BLOCK

public const int BLOCK;

The block comment type.

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 block documentation comment type.

DOCUMENTATION_SINGLE

public const int DOCUMENTATION_SINGLE;

The single line 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 // characters will be duplicated for each line.

CSharpComment

public CSharpComment( string comment );

Creates a new documentation comment with no indentation.

Parameters:

comment - the comment text

CSharpComment

public CSharpComment( int type, string comment );

Creates a new comment of the specified type.

Parameters:

type - the comment type

comment - the comment text

See Also:

DOCUMENTATION, BLOCK, SINGLELINE

Print

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

Prints the comment to the specified stream.

Parameters:

out - the output stream

style - the code style to use

indent - the indentation level