CodeEvent.DocComment Property
Gets or sets a documentation comment associated with the code event element.
Namespace: EnvDTE80
Assembly: EnvDTE80 (in EnvDTE80.dll)
Syntax
'Declaration
Property DocComment As String
string DocComment { get; set; }
property String^ DocComment {
String^ get ();
void set (String^ value);
}
abstract DocComment : string with get, set
function get DocComment () : String
function set DocComment (value : String)
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.
Remarks
An empty string is returned if no comment is provided or if the language implementing the code does not have a documentation comment mechanism.
Note
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).
Examples
The following example demonstrates how to use the DocComment property.
To test this property:
Open the target project and select the code event element by placing the cursor on the event object.
Run the add-in.
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");
}
.NET Framework Security
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.
See Also
Reference
Other Resources
How to: Compile and Run the Automation Object Model Code Examples