VCCodeClass::Comment Property

Visual Studio 2015
 

Gets or sets the comment associated with the VCCodeClass.

Namespace:   Microsoft.VisualStudio.VCCodeModel
Assembly:  Microsoft.VisualStudio.VCCodeModel (in Microsoft.VisualStudio.VCCodeModel.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 VCCodeClass.

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

Return to top
Show: