Displaying help for user defined functions

  • Thread starter Thread starter Sinex
  • Start date Start date
S

Sinex

Hi,
I have a main application (WinForms). I developed a DLL with some utility
classes. The App uses these Utility classes...creates objects of them and
then calls their public functions.
Now, while typing out the function call (say objUtility.Func1(args) ),
there is a tooltip that appears in VS that shows the arguments....i want
some help/descrption also of the arguments to be displayed in this tooltip.
What should I do? Is there some attribute that will help me for this?

Sinex
 
When you use the XML-documentationtags like the following:

/// <summary>
/// bla die bla
/// </summary>
/// <param name="a">interesting</param>
/// <param name="b">helfull</param>
public void myFunc(int a, int b)
{
...
}

You get your tooltips for free!!
 
Back
Top