This topic has not yet been rated - Rate this topic

CodeType.DocComment Property

Visual Studio 2005

Gets or sets the document comment for the CodeType element.

Namespace: EnvDTE
Assembly: EnvDTE (in envdte.dll)

string DocComment { get; set; }

/** @property */
String get_DocComment ()

/** @property */
void set_DocComment (String pDocComment)

JScript

function get DocComment () : String

function set DocComment (pDocComment : String)

Property Value

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.

Reference

CodeType Interface
CodeType Members
EnvDTE Namespace

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Additions

ADD