CodeInterface2::Comment Property

Visual Studio 2015
 

Gets or sets the comment associated with the CodeInterface.

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

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

Property Value

Type: System::String^

The comment associated with the code element.

Implements

CodeInterface::Comment

Comment sets or returns the header comment. When returned, the text does not contain any comment syntax. The text is derived from the source based on the language's comment style in terms of how far back through the sources to collect comments as being the header comment for a code element.

When set, Comment attempts to maintain the style of existing comments by using line-oriented versus delimited syntax, by maintaining any indentation prior to line-oriented syntax, by determining 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.

Return to top
Show: