CodeInterface2::DocComment Property

Visual Studio 2015
 

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

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

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

Property Value

Type: System::String^

The document comment.

Implements

CodeInterface::DocComment

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.

System_CAPS_noteNote

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.

Return to top
Show: