CodeStruct2.Comment Property

Gets or sets the comment associated with the CodeStruct.

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


Property Comment As String
string Comment { get; set; }
property String^ Comment {
    String^ get ();
    void set (String^ value);
abstract Comment : string with get, set
function get Comment () : String
function set Comment (value : String)

Property Value

Type: System.String
The comment associated with the CodeStruct.




Comment sets or returns the header comment. When returned, the text does not contain comment syntax. The text is derived from the source based on the language's comment style.

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.


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

.NET Framework Security

See Also


CodeStruct2 Interface

EnvDTE80 Namespace

Other Resources

How to: Compile and Run the Automation Object Model Code Examples

Discovering Code by Using the Code Model (Visual Basic)

Discovering Code by Using the Code Model (Visual C#)