CodeEnum.DocComment Property

 

Gets the document comment for the CodeEnum element.

Namespace:   EnvDTE
Assembly:  EnvDTE (in EnvDTE.dll)

string DocComment { get; set; }

Property Value

Type: System.String

A string representing the document comment.

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.

This property is read-only for code elements from Visual Basic source code.

System_CAPS_noteNote

The values of code model elements, such as classes, structures, functions, attributes, delegates, cannot be relied upon to remain the same at all times. For more information, see the section Code Model Element Values Can Change in Discovering Code by Using the Code Model (Visual Basic).

Return to top
Show: