CodeComment CodeComment CodeComment CodeComment Class

Definition

Represents a comment.

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

Examples

This example demonstrates using a CodeComment 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

CodeComment can be used to represent a single line comment.

A CodeCommentStatement can contain a CodeComment and allows it to be treated as a statement and generated as code within a collection of statements. Multi-line comments can be represented with multiple CodeCommentStatement objects.

To include a comment in a CodeDOM graph that can be generated to source code, add a CodeComment to a CodeCommentStatement, and add this to the statements collection of a CodeMemberMethod or to the comments collection of a CodeNamespace or any object that derives from CodeTypeMember.

Constructors

CodeComment() CodeComment() CodeComment() CodeComment()

Initializes a new instance of the CodeComment class.

CodeComment(String) CodeComment(String) CodeComment(String) CodeComment(String)

Initializes a new instance of the CodeComment class with the specified text as contents.

CodeComment(String, Boolean) CodeComment(String, Boolean) CodeComment(String, Boolean) CodeComment(String, Boolean)

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

Properties

DocComment DocComment DocComment DocComment

Gets or sets a value that indicates whether the comment is a documentation comment.

Text Text Text Text

Gets or sets the text of the comment.

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