CodeClass2.DocComment 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.

Gets or sets the document comment for the code class.

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 representing the document comment.

Implements

DocComment

Attributes: DispIdAttribute TypeLibFuncAttribute

Examples

[C#]

public void CodeClass2DocCommentExample(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 document comment for the CodeClass.  
        cls.DocComment = "<doc>This is a DocComment\r\n</doc>";  

    }  
    catch (Exception e)  
    {  
        Console.WriteLine(e.Message);  
    }  
}

Remarks

The DocComment property returns the special documentation comment or attribute if there is one in the code class. If the language implementing the code model does not have a documentation comment mechanism, or if there is none associated with the code class, 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

Freigeben über