Wednesday, September 05, 2012

Visual Studio : XML comments


Also called programmatic comments or xml documentation.

If you have a method like:

public void blah (String a, int b)


and you want the comments, just type /// on the line before and you get:

/// <summary>
/// </summary>
/// <param name="a"></param>
/// <param name="b"></param>
public void blah (String a, int b)


If you have ReSharper, put the cursor over the method name i.e. “blah” and press Ctrl / Shift / F1.

You get a neat popup window.


No comments: