Add parameter comments for a method in c#

The “feature” is called XML comments. Just type /// right before your methods and VS will generate some xml tags. These will be used to show the tooltip as well as parameter info also.

/// <summary>
/// this will be the tooltip
/// </summary>
/// <param name="args">args will be passed when starting this program</param>
static void Main(string[] args)
{

}

Screenshot of my VS2010 when calling method add. As you can see, xml comments are shown.

Screenshot of my VS2010 when calling method ADD

Advertisements

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s