CodeEvent.Comment CodeEvent.Comment CodeEvent.Comment CodeEvent.Comment CodeEvent.Comment Property

Definition

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

public:
 property System::String ^ Comment { System::String ^ get(); void set(System::String ^ value); };
public:
 property Platform::String ^ Comment { Platform::String ^ get(); void set(Platform::String ^ value); };
[System.Runtime.InteropServices.DispId(35)]
[get: System.Runtime.InteropServices.DispId(35)]
[set: System.Runtime.InteropServices.DispId(35)]
public string Comment { get; set; }
member this.Comment : string with get, set
Public Property Comment As String
Property Value

A string containing a header comment, or an empty string if no comment is provided.

Examples

The following example demonstrates how to use the Comment property.

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("
Comment property: " + codeEvent.Comment, "Testing CodeEvent"); }

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.

Applies to