CodeParameter.DocComment Property
Returns the document comment for the current code model element.
Namespace: EnvDTE
Assembly: EnvDTE (in EnvDTE.dll)
Syntax
'Declaration
Property DocComment As String
'Usage
Dim instance As CodeParameter
Dim value As String
value = instance.DocComment
instance.DocComment = value
string DocComment { get; set; }
property String^ DocComment {
String^ get ();
void set (String^ value);
}
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.
Note
This property is read-only for code elements from Visual Basic source code.
Also, 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).
.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