CodeEvent.DocComment Property

Definition

Namespace:

EnvDTE80

Assembly:

Microsoft.VisualStudio.Interop.dll

Gets or sets a documentation comment associated with the code event element.

public:
 property System::String ^ DocComment { System::String ^ get(); void set(System::String ^ value); };

public:
 property Platform::String ^ DocComment { Platform::String ^ get(); void set(Platform::String ^ value); };

[System.Runtime.InteropServices.DispId(34)]
public string DocComment { [System.Runtime.InteropServices.DispId(34)] get; [System.Runtime.InteropServices.DispId(34)] set; }

[<System.Runtime.InteropServices.DispId(34)>]
[<get: System.Runtime.InteropServices.DispId(34)>]
[<set: System.Runtime.InteropServices.DispId(34)>]
member this.DocComment : string with get, set

Public Property DocComment As String

Property Value

String

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

Attributes

DispIdAttribute

Examples

The following example demonstrates how to use the DocComment property.

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");  
}  

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.