Anyone use the "<Description...>" Attribute?

[Larry Woods]

I am trying to put a description on a Constructor of a class. All doc says
to Import System.ComponentModel, which I do. But in order to get
"<Description" to be recognized I have to use
"System.ComponentModel.Description(..." and, even then, it doesn't display
when I reference the class.

First, why do I still have to use "System.ComponentModel" when I have
Imported it?

But, secondly...and more important...why doesn't the desciption display?

TIA,

Larry Woods

 

[Ken Tucker [MVP]]

Hi,

The description attribute is for controls. It displays the text as
tooltip in the properties window. You need to use xml documentation for
that.

From Herfrieds Faq.

VB Commenter
<http://www.gotdotnet.com/team/ide/>
-> section "VB Commenter"

XML Documentation
<http://www.gotdotnet.com/team/vb/>
-> section "XML Documentation"

VBXC - VB.NET XML Commentor
<http://vbxmldoc.tor-erik.net/index.shtml>

NDOC (formerly DOC.NET)
<http://ndoc.sourceforge.net/>

VB.DOC
<http://vb-doc.sourceforge.net/>

<http://www.gotdotnet.com/Community/Workspaces/Workspace.aspx?id=112b5449-f702-46e2-87fa-86bdf39a17dd>


Ken
--------------
I am trying to put a description on a Constructor of a class. All doc says
to Import System.ComponentModel, which I do. But in order to get
"<Description" to be recognized I have to use
"System.ComponentModel.Description(..." and, even then, it doesn't display
when I reference the class.

First, why do I still have to use "System.ComponentModel" when I have
Imported it?

But, secondly...and more important...why doesn't the desciption display?

TIA,

Larry Woods

 

[Herfried K. Wagner [MVP]]

"System.ComponentModel.Description(..." and, even then, it doesn't display
when I reference the class.

First, why do I still have to use "System.ComponentModel" when I have
Imported it?

But, secondly...and more important...why doesn't the desciption display?

The 'Description' attribute is used in the properties window. For
IntelliSense tooltips, you'll have to create a special XML file:

Adding IntelliSense tooltips, XML comments, and documentation
<URL:http://dotnet.mvps.org/dotnet/faqs/?id=tooltipsxmldocumentation&lang=en>