ToolTips in IntelliSense

[benlinkknilneb]

Hi all,

I'm coding a library in VB.NET and I want to document it as best I can. The framework classes all have ToolTips in the IntelliSense that describe the functions. How can I accomplish this in my library?

Ben

 

[JohnEfford]

As of version one this was one area where C# won over VB, as it was not possible to create the these tool tip comments in VB.Net. I am not sure about this situation in VS2003. In C# you use a triple / (ie ///) to make intellisence comments. Comments are then extracted into a XML with the file name.

App.XML

So you may be able to code this file manually, I have not tried this.

Regards

 

[SHelton]

If you look in the Framework folder (e.g. C:\WINNT\Microsoft.NET\Framework\v1.0.3705) there are some XML files with the same name as a Framework class library

e.g. System.Drawing.Design.dll has a matching file named System.Drawing.Design.xml

If you look in one of these files, they include all the function and parameter descriptions that are displayed by Intellisense in the IDE for classes within the library.

I believe (although I haven't tried it yet) that you can create a similair XML file for your own class library, and the Intellisense will display the descriptions in the IDE when your library is referenced.

If you have any joy, please post to let us know.

 

[benlinkknilneb]

Thanks for the information... I'll keep you up-to-date, but I got sidetracked with another project and I probably won't get to this again for a day or 2.

Ben