CodeProperty2.DocComment CodeProperty2.DocComment CodeProperty2.DocComment CodeProperty2.DocComment CodeProperty2.DocComment Property


Gets or sets the document comment for the current code model element.

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

Property Value

A string representing the document comment.



DocComment returns the special documentation comment or attribute if there is one in the code. If the language implementing the code model does not have a documentation comment mechanism, or if there is none associated with the code element, then DocComment returns an empty string.


This property is read-only for code elements from Visual Basic source code.

Also, 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