This documentation is archived and is not being maintained.

CodeProperty.Comment Property

Gets or sets the comment associated with the code element.

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

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

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

function get Comment () : String

function set Comment (pComment : String)

Property Value

A string representing the comment associated with the code 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 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 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.

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 with the Code Model (Visual Basic).

Show: