Tooltip to describe class functions

Posted on 2005-03-18
Medium Priority
Last Modified: 2012-05-05
I'm trying to allow tooltips to show up while I program.  For example, I have created a class with multiple properties and functions.  When I create an instance of that object and start programming in it, VB.NET will list out all the members of the class and also what the declaration is.  I was wondering how I can add a description to that tooltip that gives a more descriptive explanation of that class/parameters.

Here is a brief description of my class

Public Class MyClass
   Private var1 as integer
   Private var2 as integer

'This is my description of Var1 that I wish to display
Public Property Var1() as integer
end property

'This is my description of Var2 that I wish to display
Public Property Var2() as integer
end property

'This is my description of the function.
Public Sub AddThese()
end Sub

end class

Now when I program:

Dim x as new MyClass

when I type   x.Var1  I would like a description to show up that I had above the function.

I believe this is accomplished using attributes, but not sure.  I would appreciate any sample code.  Thanks.

end sub
Question by:neelbak
Welcome to Experts Exchange

Add your voice to the tech community where 5M+ people just like you are talking about what matters.

  • Help others & share knowledge
  • Earn cash & points
  • Learn & ask questions
  • 3
LVL 25

Assisted Solution

RonaldBiemans earned 750 total points
ID: 13575528
You can't, they forgot to add that feature to Vb.net. It will be added in the next version though
LVL 25

Accepted Solution

RonaldBiemans earned 750 total points
ID: 13575547
This is one of the features Microsoft forgot to include in VB.NET  

Fortunately, you have a few options open to you.

VS.NET 2003 PowerToys, which includes a VB.NET XML Commenter - http://www.gotdotnet.com/team/ide/

VB.DOC, a free documentation system for VB.NET - http://vb-doc.sourceforge.net/

The only other thing I can thing of is DescriptionAttribute Class (System.ComponentModel) , here you can set a description for properties and methods in your class (but they only show up in the properties window and not in the object browser)

<Description("Your Description"),Category("Your Category")> _
Public sub mysub ...
LVL 25

Expert Comment

ID: 13575569
It is supported in C#

 when typing /// at the 3rd "/" you will receive a list for every parameter , remarks and return for the current method

Author Comment

ID: 13575911
Not the answer I was hoping for.  But it was accurate.  Thanks.

Expert Comment

ID: 20625713

Is that feature present in the VB.NET 2005 ?

Featured Post

Technology Partners: We Want Your Opinion!

We value your feedback.

Take our survey and automatically be enter to win anyone of the following:
Yeti Cooler, Amazon eGift Card, and Movie eGift Card!

Question has a verified solution.

If you are experiencing a similar issue, please ask a related question

Introduction As chip makers focus on adding processor cores over increasing clock speed, developers need to utilize the features of modern CPUs.  One of the ways we can do this is by implementing parallel algorithms in our software.   One recent…
Creating an analog clock UserControl seems fairly straight forward.  It is, after all, essentially just a circle with several lines in it!  Two common approaches for rendering an analog clock typically involve either manually calculating points with…
In this video we outline the Physical Segments view of NetCrunch network monitor. By following this brief how-to video, you will be able to learn how NetCrunch visualizes your network, how granular is the information collected, as well as where to f…
If you’ve ever visited a web page and noticed a cool font that you really liked the look of, but couldn’t figure out which font it was so that you could use it for your own work, then this video is for you! In this Micro Tutorial, you'll learn yo…
Suggested Courses

762 members asked questions and received personalized solutions in the past 7 days.

Join the community of 500,000 technology professionals and ask your questions.

Join & Ask a Question