CodeProperty2.Comment CodeProperty2.Comment CodeProperty2.Comment CodeProperty2.Comment CodeProperty2.Comment Property


Gets or sets the comment associated with the code element.

 property System::String ^ Comment { System::String ^ get(); void set(System::String ^ value); };
 property Platform::String ^ Comment { Platform::String ^ get(); void set(Platform::String ^ value); };
[get: System.Runtime.InteropServices.DispId(40)]
[get: System.Runtime.InteropServices.TypeLibFunc(1024)]
[set: System.Runtime.InteropServices.DispId(40)]
[set: System.Runtime.InteropServices.TypeLibFunc(1024)]
public string Comment { get; set; }
member this.Comment : string with get, set
Public Property Comment As String

Property Value

The comment associated with the code element.



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


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