VCCodeStruct.DocComment Property

Gets or sets the document comment for the current code model element.

Namespace:  Microsoft.VisualStudio.VCCodeModel
Assembly:  Microsoft.VisualStudio.VCCodeModel (in Microsoft.VisualStudio.VCCodeModel.dll)

Syntax

声明
Property DocComment As String
用法
Dim instance As VCCodeStruct
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

The document comment for the current code model element.

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.

Permissions

See Also

Reference

VCCodeStruct Interface

VCCodeStruct Members

Microsoft.VisualStudio.VCCodeModel Namespace