Create XML Comments for Custom Function in VIsual Studio 2010 @ 肖恩D++

Create XML Comments for Custom Function in VIsual Studio 2010

Posted on September 25th, 2011 Sean Add comments

     If you need to add your custom comments for your function, including function summary, parameter description, return value etc., just add “///” right before your function, then VS will generate XML layout for you.

C#

/// <summary> /// /// </summary> /// <param name="para"></param> /// <returns></returns> public bool YourFunction(int para) { //Code here }

1
2
3
4
5
6
7
8
9

/// <summary>
///
/// </summary>
/// <param name="para"></param>
/// <returns></returns>
public bool YourFunction(int para)
{
     //Code here
}

     After finish comments, enable “XML Documentation” option for your project:
1. Open project property
2. Go to “Build” tab
3. Check “Xml documentation file”
4. Build project, then check the XML comments in other project
ASP.NET Visual Studio

(No Ratings Yet)
Loading...
418 views

Leave a Reply

Be the First to Comment!

Please insert the code above to comment

Notify of new replies to this comment
Notify of all new follow-up comments

wpDiscuz