Export (0) Print
Expand All

VCCodeBase.Comment Property 

Gets or sets the comment associated with the code element.

Namespace: Microsoft.VisualStudio.VCCodeModel
Assembly: Microsoft.VisualStudio.VCCodeModel (in microsoft.visualstudio.vccodemodel.dll)

string Comment { get; set; }
/** @property */
String get_Comment ()

/** @property */
void set_Comment (/** @attribute InAttribute() */ String pComment)

function get Comment () : String

function set Comment (pComment : String)

Property Value

A comment associated with the VCCodeBase element.

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 varies 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 determining whether the comment touches the code element or is separated by a blank line, and so forth.

© 2015 Microsoft