Type: System.CodeDom.CodeCommentStatement

System.CodeDom.CodeCommentStatement Class

Assembly: System.dll
Namespace: System.CodeDom

Summary: Represents a statement consisting of a single comment.

C# Syntax:

[Serializable]
public class CodeCommentStatement : CodeStatement

Remarks

CodeCommentStatement can be used to represent a single-line comment statement. CodeCommentStatement is a statement, so it can be inserted into a statements collection and will appear on its own line. CodeCommentStatement can also be added to the comments collection of CodeNamespace or any object that derives from CodeTypeMember.

See also:

System.CodeDom Namespace | CodeComment

System.CodeDom.CodeCommentStatement Member List:

Public Constructors

ctor #1	Overloaded: `.ctor()`Default constructor. This constructor is called by derived class constructors to initialize state in this type. Initializes a new instance of the CodeCommentStatement class.
ctor #2	Overloaded: `.ctor(CodeComment comment)` Initializes a new instance of the CodeCommentStatement class using the specified comment.
ctor #3	Overloaded: `.ctor(string text)` Initializes a new instance of the CodeCommentStatement class using the specified text as contents.
ctor #4	Overloaded: `.ctor(string text, bool docComment)` Initializes a new instance of the CodeCommentStatement class using the specified text and documentation comment flag.

Public Properties

Comment	Read-write Gets or sets the contents of the comment.
LinePragma (inherited from System.CodeDom.CodeStatement)	Read-write See base class member description: System.CodeDom.CodeStatement.LinePragma Gets or sets the line the statement occurs on.
UserData (inherited from System.CodeDom.CodeObject)	Read-only See base class member description: System.CodeDom.CodeObject.UserData Gets or sets the user-definable data for the current object.

Public Methods

Equals (inherited from System.Object)	See base class member description: System.Object.Equals Derived from System.Object, the primary base class for all objects.
GetHashCode (inherited from System.Object)	See base class member description: System.Object.GetHashCode Derived from System.Object, the primary base class for all objects.
GetType (inherited from System.Object)	See base class member description: System.Object.GetType Derived from System.Object, the primary base class for all objects.
ToString (inherited from System.Object)	See base class member description: System.Object.ToString Derived from System.Object, the primary base class for all objects.

Protected Methods

Finalize (inherited from System.Object)	See base class member description: System.Object.Finalize Derived from System.Object, the primary base class for all objects.
MemberwiseClone (inherited from System.Object)	See base class member description: System.Object.MemberwiseClone Derived from System.Object, the primary base class for all objects.

Hierarchy:

System.Object

System.CodeDom.CodeObject

System.CodeDom.CodeStatement

System.CodeDom.CodeCommentStatement

System.CodeDom.CodeCommentStatement Member Details

Overloaded ctor #1

Summary: Initializes a new instance of the CodeCommentStatement class.

Default constructor. This constructor is called by derived class constructors to initialize state in this type.

C# Syntax:


            public CodeCommentStatement();

Return to top

Overloaded ctor #2

Summary: Initializes a new instance of the CodeCommentStatement class using the specified comment.

C# Syntax:


            public CodeCommentStatement(
   CodeComment comment
);

Parameters:

comment

A CodeComment that indicates the comment.

Return to top

Overloaded ctor #3

Summary: Initializes a new instance of the CodeCommentStatement class using the specified text as contents.

C# Syntax:


            public CodeCommentStatement(
   string text
);

Parameters:

text

The contents of the comment.

Return to top

Overloaded ctor #4

Summary: Initializes a new instance of the CodeCommentStatement class using the specified text and documentation comment flag.

C# Syntax:


            public CodeCommentStatement(
   string text,
   bool docComment
);

Parameters:

text

The contents of the comment.

docComment

true if the comment is a documentation comment; otherwise, false.

Return to top

Property: Comment (read-write)

Summary: Gets or sets the contents of the comment.

C# Syntax:


            public CodeComment Comment {get; set;}

See also:
CodeComment

Return to top

Property: LinePragma (read-write)

Inherited
See base class member description: System.CodeDom.CodeStatement.LinePragma

Summary: Gets or sets the line the statement occurs on.

C# Syntax:


            public CodeLinePragma LinePragma {get; set;}

Remarks

This property indicates the location of the statement.

See also:
CodeLinePragma

Return to top

Property: UserData (read-only)

Inherited
See base class member description: System.CodeDom.CodeObject.UserData

Summary: Gets or sets the user-definable data for the current object.

C# Syntax:


            public IDictionary UserData {get;}

Remarks

Notes to inheritors: An inheritor can design the way this user data is stored, retrieved, and used.

Return to top

Method: Equals(
object obj
)

Inherited
See base class member description: System.Object.Equals

C# Syntax:


            public virtual bool Equals(
   object obj
);