CodeClass2.Comment Property

Reference

Definition

Namespace:: EnvDTE80

Assembly:: EnvDTE80.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.12.40391

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Sets or gets the comment associated with the code class.

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(38)]
public string Comment { [System.Runtime.InteropServices.DispId(38)] [System.Runtime.InteropServices.TypeLibFunc(1024)] get; [System.Runtime.InteropServices.DispId(38)] [System.Runtime.InteropServices.TypeLibFunc(1024)] set; }

[<System.Runtime.InteropServices.DispId(38)>]
[<get: System.Runtime.InteropServices.DispId(38)>]
[<get: System.Runtime.InteropServices.TypeLibFunc(1024)>]
[<set: System.Runtime.InteropServices.DispId(38)>]
[<set: System.Runtime.InteropServices.TypeLibFunc(1024)>]
member this.Comment : string with get, set

Public Property Comment As String

Property Value

String

A string representing the comment.

Implements

Comment

Attributes: DispIdAttribute TypeLibFuncAttribute

Examples

[C#]

public void CodeClass2CommentExample(DTE2 dte2)  
{  
    // Before running this example, open a code document from a project  
    // and place the insertion point within a class definition.  
    try  
    {   // Get the CodeClass2 at the insertion point.  
        TextSelection sel =   
        (TextSelection)dte2.ActiveDocument.Selection;  
        CodeClass2 cls = (CodeClass2)sel.ActivePoint.get_CodeElement(  
            vsCMElement.vsCMElementClass);  

        // Set the header comment for the CodeClass.  
        cls.Comment = "Comment added programmatically.";  
    }  
    catch (Exception e)  
    {  
        Console.WriteLine(e.Message);  
    }  
}

Remarks

Comment sets or returns the header comment for the class. Returned 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, Comment 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).

Applies to

Compartilhar via