CodeCommentStatement CodeCommentStatement CodeCommentStatement CodeCommentStatement Class

Definition

Represents a statement consisting of a single comment.

public ref class CodeCommentStatement : System::CodeDom::CodeStatement
[System.Runtime.InteropServices.ComVisible(true)]
[System.Runtime.InteropServices.ClassInterface(System.Runtime.InteropServices.ClassInterfaceType.AutoDispatch)]
[System.Serializable]
public class CodeCommentStatement : System.CodeDom.CodeStatement
type CodeCommentStatement = class
    inherit CodeStatement
Public Class CodeCommentStatement
Inherits CodeStatement
Inheritance
CodeCommentStatementCodeCommentStatementCodeCommentStatementCodeCommentStatement
Attributes

Examples

This example demonstrates using a CodeCommentStatement to represent a comment in source code.

// Create a CodeComment with some example comment text.

// The text of the comment.
// Whether the comment is a comment intended for documentation purposes.
CodeComment^ comment = gcnew CodeComment( "This comment was generated from a System.CodeDom.CodeComment",false );

// Create a CodeCommentStatement that contains the comment, in order
// to add the comment to a CodeTypeDeclaration Members collection.
CodeCommentStatement^ commentStatement = gcnew CodeCommentStatement( comment );

// A C# code generator produces the following source code for the preceeding example code:
// // This comment was generated from a System.CodeDom.CodeComment
// Create a CodeComment with some example comment text.
CodeComment comment = new CodeComment(
    // The text of the comment.
    "This comment was generated from a System.CodeDom.CodeComment",
    // Whether the comment is a comment intended for documentation purposes.
    false );

// Create a CodeCommentStatement that contains the comment, in order
// to add the comment to a CodeTypeDeclaration Members collection.
CodeCommentStatement commentStatement = new CodeCommentStatement( comment );

// A C# code generator produces the following source code for the preceeding example code:

// // This comment was generated from a System.CodeDom.CodeComment
' Create a CodeComment with some example comment text.
Dim comment As New CodeComment( _
   "This comment was generated from a System.CodeDom.CodeComment", _
   False) ' Whether the comment is a documentation comment.

' Create a CodeCommentStatement that contains the comment, in order
' to add the comment to a CodeTypeDeclaration Members collection.
Dim commentStatement As New CodeCommentStatement(comment)	

' A Visual Basic code generator produces the following source code for the preceeding example code:

' 'This comment was generated from a System.CodeDom.CodeComment

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.

Constructors

CodeCommentStatement() CodeCommentStatement() CodeCommentStatement() CodeCommentStatement()

Initializes a new instance of the CodeCommentStatement class.

CodeCommentStatement(CodeComment) CodeCommentStatement(CodeComment) CodeCommentStatement(CodeComment) CodeCommentStatement(CodeComment)

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

CodeCommentStatement(String) CodeCommentStatement(String) CodeCommentStatement(String) CodeCommentStatement(String)

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

CodeCommentStatement(String, Boolean) CodeCommentStatement(String, Boolean) CodeCommentStatement(String, Boolean) CodeCommentStatement(String, Boolean)

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

Properties

Comment Comment Comment Comment

Gets or sets the contents of the comment.

EndDirectives EndDirectives EndDirectives EndDirectives

Gets a CodeDirectiveCollection object that contains end directives.

(Inherited from CodeStatement)
LinePragma LinePragma LinePragma LinePragma

Gets or sets the line on which the code statement occurs.

(Inherited from CodeStatement)
StartDirectives StartDirectives StartDirectives StartDirectives

Gets a CodeDirectiveCollection object that contains start directives.

(Inherited from CodeStatement)
UserData UserData UserData UserData

Gets the user-definable data for the current object.

(Inherited from CodeObject)

Methods

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType() GetType()

Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

Returns a string that represents the current object.

(Inherited from Object)

Applies to

See also