DescriptionAttribute

  • Thread starter Thread starter Guest
  • Start date Start date
G

Guest

I don't seem to get description text when hovering over the properties and
methods that my control exposes. I use Description[("description txt")]
attribute. The description is however showing when viewing Properties and
Events in the DevStudio's "Properties" tab.

Any way to get the description to snow in code when typing as well?

Thanks
 
You're going to need to use XML comments. Add the appropriate XML comments
to all the methods/properties/events/etc. You should see an option to set
the "XML Documentation File" through the "Configuration Properties - >
Build" section of the property page for the project (C#). This output file
should be named the same as your assembly, but with the xml extension. Place
this xml file in the same directory with your assembly. XML documentation is
only supported out of the box, for VS.Net 2003, in C#
(http://msdn.microsoft.com/library/default.asp?url=/library/en-us/csref/html
/vcoriXMLDocumentation.asp). But if you're using VB.Net I think that there
is an add-on to allow XML comments.
 
Got it, thanks a lot!

Tim Wilson said:
You're going to need to use XML comments. Add the appropriate XML comments
to all the methods/properties/events/etc. You should see an option to set
the "XML Documentation File" through the "Configuration Properties - >
Build" section of the property page for the project (C#). This output file
should be named the same as your assembly, but with the xml extension. Place
this xml file in the same directory with your assembly. XML documentation is
only supported out of the box, for VS.Net 2003, in C#
(http://msdn.microsoft.com/library/default.asp?url=/library/en-us/csref/html
/vcoriXMLDocumentation.asp). But if you're using VB.Net I think that there
is an add-on to allow XML comments.

--
Tim Wilson
..Net Compact Framework MVP

Serg said:
I don't seem to get description text when hovering over the properties and
methods that my control exposes. I use Description[("description txt")]
attribute. The description is however showing when viewing Properties and
Events in the DevStudio's "Properties" tab.

Any way to get the description to snow in code when typing as well?

Thanks
Click to expand...
Click to expand...
 
Back
Top