CodeProperty.Comment Property

Definition

Namespace:

EnvDTE

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Gets or sets the comment associated with the code element.

public:
 property System::String ^ Comment { System::String ^ get(); void set(System::String ^ value); };

public:
 property Platform::String ^ Comment { Platform::String ^ get(); void set(Platform::String ^ value); };

[System.Runtime.InteropServices.DispId(40)]
public string Comment { [System.Runtime.InteropServices.DispId(40)] [System.Runtime.InteropServices.TypeLibFunc(1024)] get; [System.Runtime.InteropServices.DispId(40)] [System.Runtime.InteropServices.TypeLibFunc(1024)] set; }

[<System.Runtime.InteropServices.DispId(40)>]
[<get: System.Runtime.InteropServices.DispId(40)>]
[<get: System.Runtime.InteropServices.TypeLibFunc(1024)>]
[<set: System.Runtime.InteropServices.DispId(40)>]
[<set: System.Runtime.InteropServices.TypeLibFunc(1024)>]
member this.Comment : string with get, set

Public Property Comment As String

Property Value

String

A string representing the comment associated with the code element.

Attributes

DispIdAttribute TypeLibFuncAttribute

Remarks

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.

Note

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