CodeType.DocComment Property

Gets or sets the document comment for the CodeType element.

Namespace:  EnvDTE
Assembly:  EnvDTE (in EnvDTE.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: System.String
A string representing the document comment.

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

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

.NET Framework Security

See Also

Reference

CodeType Interface

EnvDTE Namespace