CodeInterface2.Comment Property

Reference

Definition

Namespace:: EnvDTE80

Assembly:: EnvDTE80.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.11.40262

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets or sets the comment associated with the CodeInterface.

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(38)]
public string Comment { [System.Runtime.InteropServices.DispId(38)] [System.Runtime.InteropServices.TypeLibFunc(1024)] get; [System.Runtime.InteropServices.DispId(38)] [System.Runtime.InteropServices.TypeLibFunc(1024)] set; }

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

Public Property Comment As String

Property Value

String

The comment associated with the code element.

Implements

Comment

Attributes: DispIdAttribute TypeLibFuncAttribute

Remarks

Comment sets or returns the header comment. When returned, the text does not contain any comment syntax. The text is derived from the source based on the language's comment style in terms of how far back through the sources to collect comments as being the header comment for a code element.

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.

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.

Applies to

Compartilhar via