c#注释

在c#编程中使用xml注释提高编程效率及协作容易度

c#把注释集成到程序文件中，并且能够部分在代码调用时显示预览。

具体做法：

普通注释使用两个斜杠，例如： //注释，别理我。

xml注释采用三个斜杠，使如：///<summary>按照xml规则解释我！</summary>

c#注释的魅力正在于xml注释，它提供的增效十分诱人，其中诱人的增效之一是可以在调用时查阅类的简介及方法的参数注释。

例如：

///<summary>限制字符数</summary>

///<param name="s">原始字符串</param>

///<param name="len">保留的字符串长度</param>

///<returns>截断后留下来的字符串</returns>

public static string Fix(string s, int len)

其实<summary>及<param>标签是对编写程序最有帮助的。插入xml注释的时候，如果你使用vs2005 IDE，这些xml标签具备代码提示功能，因此你不必自己敲完这些xml标签，记住大概的名字即可。

有一篇文章非常有参考的价值：

http://blog.csdn.net/xuxiaoping_cumt/archive/2005/11/17/531476.aspx

标题：把 Visual Studio .NET 源代码文件中C# XML注释提取成工程文档