CodeType.Comment Property
Gets or sets the comment associated with the CodeType.
Namespace: EnvDTE
Assembly: EnvDTE (in EnvDTE.dll)
Syntax
'Declaration
Property Comment As String
string Comment { get; set; }
property String^ Comment {
String^ get ();
void set (String^ value);
}
abstract Comment : string with get, set
function get Comment () : String
function set Comment (value : String)
Property Value
Type: System.String
A string representing the comment associated with the CodeType.
Remarks
Comment sets or returns the header comment. When returned, the text does not contain comment syntax.
The comment text is derived from the source document that contains the code element. The number of header comment lines collected will vary depending on the language in which the comments are written.
When set, Comment attempts to maintain the style of any existing comment by using line-oriented versus delimited syntax, by maintaining indentation prior to line-oriented syntax, by determining whether the comment touches the code element or is separated by a blank line, and so forth.
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).
.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