QuickInfo in VS 08 for custom methods
-
05-07-2019 - |
Question
Is it possible (and if yes, how?) to provide custom classes, types, whatsoever with the QuickInfo-Hovers provided by the .NET-Base-classes that explain e.g. a summary or definitions of the parameters and exceptions?
(Example for clarification)
QuickInfo http://img137.imageshack.us/img137/9720/quickinfo.jpg
Solution
You need to add XML Comments to your method.
GhostDoc is a free tool that will give you a context menu option that has a stab at it for you ;)
Kindness,
Dan
OTHER TIPS
You can use XML comments in your code. Decorate your custom method with comments:
/// <summary>
/// Some description
/// </summary>
/// <param name="arg">Some argument</param>
static void SomeCustomMethod(int arg)
{
}
Enable XML comments when compiling the assembly. Add the MyAssembly.XML to the references and your custom method description will be shown.
Licensed under: CC-BY-SA with attribution
Not affiliated with StackOverflow