Share via


VCCodeVariable.DocComment Property

Gets the document comment for the current code model element.

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

Syntax

'Declaration
Property DocComment As String
    Get
    Set
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: 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.

Note

DocComment is read-only for code elements from Visual Basic source code.

.NET Framework Security

See Also

Reference

VCCodeVariable Interface

Microsoft.VisualStudio.VCCodeModel Namespace