CodeEvent::DocComment Property

Visual Studio 2015
 

Gets or sets a documentation comment associated with the code event 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^

A string containing a documentation comment associated with the code event element, or an empty string if no comment is provided.

An empty string is returned if no comment is provided or if the language implementing the code does not have a documentation comment mechanism.

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.

The following example demonstrates how to use the DocComment property.

C#
Copy 
public static void DocComment(EnvDTE80.DTE2 dte)
{
    TextSelection objTextSel;
    EnvDTE80.CodeEvent codeEvent;
    objTextSel = (TextSelection)dte.ActiveDocument.Selection;
    codeEvent = (EnvDTE80.CodeEvent)objTextSel.ActivePoint.get_CodeElement(vsCMElement.vsCMElementEvent);

    MessageBox.Show("\nDocComment property: " +
                    codeEvent.DocComment, "Testing CodeEvent");
}
Return to top
Show: