JMK
JMK

Reputation: 28080

How do I provide custom Intellisense descriptions in Visual Studio

Ok so let's say I have the following class in C#:

class Foo
{
    public void Bar() { Console.WriteLine("FooBar"); }
}

In Visual Studio, whenever I instantiate my class and implement my method intellisense looks like this:

FooBar

All this is showing is the name, return type and input parameters of my method. When viewing any method inside any of the .Net base classes using intellisense, a description is provided.

How do I add a description for my own methods to intellisense, so anybody who uses a *.dll I have written in the future can understand what my methods do without having to refer to external documentation?

Thanks

Upvotes: 2

Views: 506

Answers (1)

Steve B
Steve B

Reputation: 37710

Add xml documentation :

/// <summary>
/// Foos something
/// </summary>
public void Foo()
{
}

Upvotes: 3

Related Questions