CodeClass.Comment Property

Definition

Namespace:

EnvDTE

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Gets or sets the comment associated with the CodeClass object.

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 comments associated with the CodeClass object.

Attributes

DispIdAttribute TypeLibFuncAttribute

Examples

Public Sub CodeClassExample(ByVal dte As DTE2)   
    ' Before running this example, open a code document from a  
    ' project and place the insertion point inside a class definition.  
    Try  
        Dim objTextSel As TextSelection  
        Dim objCodeCls As CodeClass  
        objTextSel = CType(dte.ActiveDocument.Selection, TextSelection)  
        objCodeCls = CType(objTextSel.ActivePoint.CodeElement(vsCMElement.vsCMElementClass), CodeClass)  
        ' Add comments to CodeClass objCodeClass - notice change in code document.  
        objCodeCls.Comment = "Comments for the CodeClass object."  
        ' Access top-level object through the CodeClass object  
        ' and return the file name of that top-level object.  
        MessageBox.Show("Top-level object's filename: " + objCodeCls.DTE.FileName)  
        ' Get the language used to code the CodeClass object - returns a GUID.  
        MessageBox.Show(objCodeCls.Language)  
        ' Get a collection of elements contained by the CodeClass object.  
        Dim members As String = "Member Elements of " + objCodeCls.Name + ": " + vbCrLf  
        Dim elem As CodeElement  
        For Each elem In  objCodeCls.Members  
            members = members + (elem.Name + vbCrLf)  
        Next elem  
        MessageBox.Show(members)  
    Catch ex As Exception  
        MessageBox.Show(ex.Message)  
    End Try  
End Sub  

public void CodeClassExample(DTE2 dte)  
{  
   // Before running this example, open a code document from a  
   // project and place the insertion point inside a class definition.  
   try  
   {  
      TextSelection objTextSel;  
      CodeClass objCodeCls;  
      objTextSel = (TextSelection)dte.ActiveDocument.Selection;  
      objCodeCls = (CodeClass)objTextSel.ActivePoint.get_CodeElement(vsCMElement.vsCMElementClass);  
      // Add comments to CodeClass objCodeClass - notice change in code document.  
      objCodeCls.Comment = "Comments for the CodeClass object.";  
      // Access top-level object through the CodeClass object  
      // and return the filename of that top-level object.  
      MessageBox.Show("Top-level object's filename: " + objCodeCls.DTE.FileName);  
      // Get the language used to code the CodeClass object - returns a GUID.  
      MessageBox.Show(objCodeCls.Language);  
      // Get a collection of elements contained by the CodeClass object.  
      string members = "Member Elements of " + objCodeCls.Name + ": \n";  
      foreach (CodeElement elem in objCodeCls.Members)  
      {  
         members = members + (elem.Name + "\n");  
      }  
      MessageBox.Show(members);  
   }  
   catch (Exception ex)  
   {  
      MessageBox.Show(ex.Message);  
   }  
}  

Remarks

Comment sets or returns the header comment. When returned, the text does not contain any comment syntax.

The comment text is derived from the source document that contains the code element. The number of header comment lines collected will vary depending on the language in which the comments are written.

When set, Comment attempts to maintain the style of any existing comment by using line-oriented versus delimited syntax, by maintaining indentation prior to line-oriented syntax, by maintaining whether the comment touches the code element or is separated by a blank line, and so forth.

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).