This documentation is archived and is not being maintained.

DocComment Property (General Extensibility)

Visual Studio .NET 2003

Returns the document comment for the current code model element.

[Visual Basic .NET]
Public Property DocComment() As String
[Visual Basic 6]
Property Get DocComment() As String
Property Let DocComment( _
   ByVal NewValue As String _
HRESULT __stdcall get_DocComment(
   /* [out, retval] */ BSTR* retVal
HRESULT __stdcall put_DocComment(
   /* [in] */ BSTR NewValue
string DocComment {get; set;}
[JScript .NET]
public function get DocComment() : String
public function set DocComment(
   NewValue : String


The document comment text.


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 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 .NET source code.

See Also

Applies To: CodeClass Object | CodeDelegate Object | CodeEnum Object | CodeFunction Object | CodeInterface Object | CodeNamespace Object | CodeParameter Object | CodeProperty Object | CodeStruct Object | CodeType Object | CodeVariable Object | VCCodeClass Object | VCCodeDelegate Object | VCCodeEnum Object | VCCodeFunction Object | VCCodeInterface Object | VCCodeNamespace Object | VCCodeParameter Object | VCCodeProperty Object | VCCodeStruct Object | VCCodeUnion Object | VCCodeVariable Object