How to have comments in IntelliSense for function in Visual Studio?

c# vb.net visual-studio visual-studio-2008 xml-comments
Ali picture Ali · Feb 9, 2009 · Viewed 135.2k times · Source

In Visual Studio and C#, when using a built in function such as ToString(), IntelliSense shows a yellow box explaining what it does.

alt text alt text

How can I have that for functions and properties I write?

Answer

Solmead picture Solmead · Feb 9, 2009

To generate an area where you can specify a description for the function and each parameter for the function, type the following on the line before your function and hit Enter:

  • C#: ///

  • VB: '''

See Recommended Tags for Documentation Comments (C# Programming Guide) for more info on the structured content you can include in these comments.

Related questions

How to get source code of a Windows executable?

I've got some old Windows executable files. How can I edit them with Visual Studio 2010? What are the ways to see an exe's source code?

Read More
Is there a way to navigate to real implementation of method behind an interface?

In Visual Studio, when you right-click a method call, you go to the implementation of that method inside a class except if you access this method through an interface: in that case you go to the interface method not to …

Read More
Can I publish a private NuGet package?

I have an assembly that I have made which is very specific to my team at my company. I want to be able to use NuGet to make this assembly avaiable to other projects that my team and similar teams …

Read More