VCCodeInclude.Comment Property
Get or sets the comment associated with the code element.
Namespace: Microsoft.VisualStudio.VCCodeModel
Assembly: Microsoft.VisualStudio.VCCodeModel (in Microsoft.VisualStudio.VCCodeModel.dll)
Syntax
声明
Property Comment As String
用法
Dim instance As VCCodeInclude
Dim value As String
value = instance.Comment
instance.Comment = value
string Comment { get; set; }
property String^ Comment {
String^ get ();
void set (String^ value);
}
function get Comment () : String
function set Comment (value : String)
Property Value
Type: System.String
The comment associated with the code element.
Remarks
Comment sets or returns the header comment. When returned, the text does not contain any comment syntax. The comment text is derived from the source document that contains the code element. The number of header comment lines collected varies 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 any indentation prior to line-oriented syntax, by maintaining whether the comment touches the code element or is separated by a blank line, and so forth.
Permissions
- 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
Concepts
How to: Compile and Run the Automation Object Model Code Examples