Functions and Design-Time tooltips...

A

Anthony Williams

Hi guys,

I'm just about to release a class library full of functions to my
development team, and was just wondering - for a bit of finesse and to help
the guys out at design-time - is there any way for me to create my own
function description tooltips that will be shown in the VS.NET code view
when they use my functions? I've not really had much exposure to metadata
before, so any pointers would be greatly appreciated.

Cheers,
Anth
 
H

Herfried K. Wagner [MVP]

Hello,

Anthony Williams said:
I'm just about to release a class library full of functions
to my development team, and was just wondering - for
a bit of finesse and to help the guys out at design-time
- is there any way for me to create my own function
description tooltips that will be shown in the VS.NET
code view when they use my functions?

There are some tools available which can be used to generate the XML file
required for the tooltips:

My XML Comments 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/
 
A

Anthony Williams

Herfried,

Thanks for the resources - the XML Documentation tool seems to do the trick!

Job done!


Cheers,
Anth
 

Ask a Question

Want to reply to this thread or ask your own question?

You'll need to choose a username for the site, which only take a couple of moments. After that, you can post your question and our members will help you out.

Ask a Question

Top