CodeEnum.DocComment Property
Gets the document comment for the CodeEnum element.
Namespace: EnvDTE
Assembly: EnvDTE (in EnvDTE.dll)
Syntax
'Declaration
Property DocComment As String
string DocComment { get; set; }
property String^ DocComment {
String^ get ();
void set (String^ value);
}
abstract DocComment : string with get, set
function get DocComment () : String
function set DocComment (value : String)
Property Value
Type: System.String
A string representing the document comment.
Remarks
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.
Note
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).
.NET Framework Security
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.
See Also
Reference
Other Resources
How to: Compile and Run the Automation Object Model Code Examples