VCCodeProperty::DocComment Property

Visual Studio 2015
 

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

Namespace:   Microsoft.VisualStudio.VCCodeModel
Assembly:  Microsoft.VisualStudio.VCCodeModel (in Microsoft.VisualStudio.VCCodeModel.dll)

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

Property Value

Type: System::String^

The document comment for the current code model element.

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.

Return to top
Show: