CodeClass2.DocComment Property
Gets or sets the document comment for the code class.
Namespace: EnvDTE80
Assembly: EnvDTE80 (in EnvDTE80.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: String
A string representing the document comment.
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).
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);
}
}
.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