CodeClass.DocComment Property

Reference

Definition

Namespace:: EnvDTE

Assembly:: EnvDTE.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.11.40262

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 document comment for the current code model 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(37)]
public string DocComment { [System.Runtime.InteropServices.DispId(37)] [System.Runtime.InteropServices.TypeLibFunc(1024)] get; [System.Runtime.InteropServices.DispId(37)] [System.Runtime.InteropServices.TypeLibFunc(1024)] set; }

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

Public Property DocComment As String

Property Value

String

A string containing special documentation comment or attribute.

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  
        Dim objCodeType As CodeType  
        Dim objCMElem As vsCMElement  
        objTextSel = CType(dte.ActiveDocument.Selection, TextSelection)  
        objCodeCls = CType(objTextSel.ActivePoint.CodeElement _  
          (vsCMElement.vsCMElementClass), CodeClass)  
        ' Add DocComment to CodeClass objCodeClass.  
        objCodeCls.DocComment = "<DOC>DocComment for the CodeClass _  
          object</DOC>"  
        MsgBox(objCodeCls.DocComment)  
        ' Test if a CodeType object is obtainable from the CodeClass.  
        If objCodeCls.IsCodeType Then  
            ' We can cast the CodeClass to a CodeType  
            objCodeType = CType(objCodeCls, CodeType)  
        Else   
            ' The CodeClass object is not a CodeType but is  
            ' some Kind of element  
            objCMElem = objCodeCls.Kind  
        End If  
    Catch ex As Exception  
        MsgBox.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;  
      CodeType objCodeType;  
      vsCMElement objCMElem;  
      objTextSel = (TextSelection)dte.ActiveDocument.Selection;  
      objCodeCls = (CodeClass)objTextSel.ActivePoint.get_CodeElement  
        (vsCMElement.vsCMElementClass);  
      // Add DocComment to CodeClass objCodeClass.  
      objCodeCls.DocComment = "<DOC>DocComment for the CodeClass   
        object</DOC>";  
      MessageBox.Show(objCodeCls.DocComment);  
      // Test if a CodeType object is obtainable from the CodeClass.  
      if (objCodeCls.IsCodeType)  
      { // then we can cast the CodeClass to a CodeType  
         objCodeType = (CodeType)objCodeCls;  
      }  
      else // the CodeClass object is not a CodeType but is  
      {    // some Kind of element  
         objCMElem = objCodeCls.Kind;  
      }  
   }  
   catch (Exception ex)  
   {   
      MessageBox.Show(ex.Message);  
   }  
}

Remarks

DocComment works differently with Visual Basic and Visual C++ than it does with Visual C#. Visual C# surrounds the XML returned by DocComment with <doc> tags, but Visual Basic and Visual C++ do not. For example, Visual Basic and Visual C++ return:

<summary>  
</summary>  
<value>  
</value>

Whereas Visual C# returns:

<doc>  
  <summary>  
  </summary>  
  <value>  
  </value>  
</doc>

As a result, you need to keep the programming language in mind and adjust your handling of the resultant XML accordingly.

DocComment returns the special documentation comment or attribute if there is one in the code. If the language implementing the code model does not have a documentation comment mechanism, or if there is none associated with the code element, then DocComment returns an empty string.

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