This documentation is archived and is not being maintained.

CodeComment Class

Represents a comment.

Namespace:  System.CodeDom
Assembly:  System (in System.dll)

public class CodeComment : CodeObject

The CodeComment type exposes the following members.

Public methodCodeComment()Initializes a new instance of the CodeComment class.
Public methodCodeComment(String)Initializes a new instance of the CodeComment class with the specified text as contents.
Public methodCodeComment(String, Boolean)Initializes a new instance of the CodeComment class using the specified text and documentation comment flag.

Public propertyDocCommentGets or sets a value that indicates whether the comment is a documentation comment.
Public propertyTextGets or sets the text of the comment.
Public propertyUserDataGets the user-definable data for the current object. (Inherited from CodeObject.)

Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

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.

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

// 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

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.