CodeComment Class

.NET Framework (current version)

Other Versions

Represents a comment.

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

Inheritance Hierarchy

System::Object
System.CodeDom::CodeObject
System.CodeDom::CodeComment

Syntax

C++

[SerializableAttribute]
[ClassInterfaceAttribute(ClassInterfaceType::AutoDispatch)]
[ComVisibleAttribute(true)]
public ref class CodeComment : CodeObject

Constructors

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

Properties

	Name	Description
	DocComment	Gets or sets a value that indicates whether the comment is a documentation comment.
	Text	Gets or sets the text of the comment.
	UserData	Gets the user-definable data for the current object.(Inherited from CodeObject.)

Methods

	Name	Description
	Equals(Object^)	Determines whether the specified object is equal to the current object.(Inherited from Object.)
	Finalize()	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)
	GetHashCode()	Serves as the default hash function. (Inherited from Object.)
	GetType()	Gets the Type of the current instance.(Inherited from Object.)
	MemberwiseClone()	Creates a shallow copy of the current Object.(Inherited from Object.)
	ToString()	Returns a string that represents the current object.(Inherited from Object.)

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.

Examples

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

C++

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

Version Information

.NET Framework
Available since 1.1

Thread Safety

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