CodeClass::Comment Property

Visual Studio 2015
 

Gets or sets the comment associated with the CodeClass object.

Namespace:   EnvDTE
Assembly:  EnvDTE (in EnvDTE.dll)

C#
C++
F#
VB
Copy 
property String^ Comment {
	String^ get();
	void set(String^ value);
}

Property Value

Type: System::String^

A string representing the comments associated with the CodeClass object.

Comment sets or returns the header comment. When returned, the text does not contain any comment syntax.

The comment text is derived from the source document that contains the code element. The number of header comment lines collected will vary depending on the language in which the comments are written.

When set, Comment attempts to maintain the style of any existing comment by using line-oriented versus delimited syntax, by maintaining indentation prior to line-oriented syntax, by maintaining whether the comment touches the code element or is separated by a blank line, and so forth.

System_CAPS_noteNote

The values of code model elements such as classes, structs, functions, attributes, delegates, and so forth can be non-deterministic after making certain kinds of edits, meaning that their values cannot be relied upon to always remain the same. For more information, see the section Code Model Element Values Can Change in Discovering Code by Using the Code Model (Visual Basic).

C#
VB
C++
Copy
No code example is currently available or this language may not be supported.
Return to top
Show: