CodeStruct2.Comment CodeStruct2.Comment CodeStruct2.Comment CodeStruct2.Comment CodeStruct2.Comment Property

Definition

Gets or sets the comment associated with the CodeStruct.

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)]
[get: System.Runtime.InteropServices.DispId(38)]
[get: System.Runtime.InteropServices.TypeLibFunc(1024)]
[set: System.Runtime.InteropServices.DispId(38)]
[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 CodeStruct.

Implements

Remarks

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.

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