CodeEvent.Comment Property

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

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

Syntax

'Declaration
Property Comment As String

string Comment { get; set; }

property String^ Comment {
    String^ get ();
    void set (String^ value);
}

abstract Comment : string with get, set

function get Comment () : String
function set Comment (value : String)

Property Value

Type: System.String
A string containing a header comment, or an empty string if no comment is provided.

Remarks

Retrieved text does not contain any comment syntax. The text is derived from the source based on the language's comment style. For example, in C#, the comment delimiter is //, but in Visual Basic, it is either an apostrophe (') or Rem (short for remark).

When set, the Comment property attempts to maintain the style of any existing comment by using line-oriented versus delimited syntax. In the process, it maintains any indentation prior to line-oriented syntax by determining whether the comment touches the code element or is separated by a blank line.

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 Comment property.

To test this property:

1. Open the target project and select the code event element by placing the cursor on the event object.

2. Run the add-in.

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

    MessageBox.Show("\nComment property: " +
                    codeEvent.Comment, "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

CodeEvent Interface

EnvDTE80 Namespace

Other Resources

How to: Compile and Run the Automation Object Model Code Examples

Discovering Code by Using the Code Model (Visual Basic)

Discovering Code by Using the Code Model (Visual C#)