CodeDelegate::DocComment Property

Visual Studio 2015
 

Sets or gets the documentation comments for CodeDelegate element.

Namespace:   EnvDTE
Assembly:  EnvDTE (in EnvDTE.dll)

C#
C++
F#
VB
Copy 
property String^ DocComment {
	String^ get();
	void set(String^ value);
}

Property Value

Type: System::String^

A string containing the documentation comments for the delegate.

DocComment returns the special documentation comment or attribute for the delegate 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.

System_CAPS_noteNote

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. For more information, see the section Code Model Element Values Can Change in Discovering Code by Using the Code Model (Visual Basic).

Return to top
Show: