Share via

VCCodeBase.Comment Property

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.VCCodeModel
Assembly:
Microsoft.VisualStudio.VCCodeModel.dll

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(577)]
public string Comment { [System.Runtime.InteropServices.DispId(577)] get; [System.Runtime.InteropServices.DispId(577)] set; }
[<System.Runtime.InteropServices.DispId(577)>]
[<get: System.Runtime.InteropServices.DispId(577)>]
[<set: System.Runtime.InteropServices.DispId(577)>]
member this.Comment : string with get, set
Public Property Comment As String

Property Value

String

A comment associated with the VCCodeBase element.

Attributes
DispIdAttribute

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

Applies to