在C#代码中，另一个常见的语句是注释。注释并不是严格意义上的C#代码，但代码最好有注释。注释就是解释，即给代码添加描述性文本
编译器会忽略这些内容（在本系列的Sql Server 2008书中也有详细讲到为什么要用注释）。在开始处理比较长的代码段时，注释可用于给正在进行的工作添加提示，例如在本书第一章中那两个实例中，我们自己写的代码上都写了注释。C#添加注释的方式有两种。可以在注释的开头和结尾分别放置"/*"和" */"标记，也可以如上一章实例中那样使用一个标记"//"，不过使用这种方式的注释，是不能换行的哦。也就是说一个 // 符号只能代表注释一行。
要使用第一种方式标记注释，可以在注释的开头加上"/*"，在末尾加上"*/"。这些注释符号可以在单独一行上，也可以在不同的行上，注释符号之间的所有内容都是注释。
在C#中，对于一个类檔进行总体说明，常常会用到这种注释方式，如下代码顶部的注释是针对当前文件的说明：
/*----------------------------------------------------------------------------------
* 版权说明：本代码档为***版权所有，未经本公司
* 书面授权任何人或公司不得使用此檔中的部分和全部内容
* 单元名称：Guide_Star
* 单元描述：导游等级星业务类，主要实现对导游星级的SIDU操作；
* 实现针对不同的星级获取导游列表；
* 星级规则的业务逻辑；
* 创建人：老田
* 版本：1.0
* 创建日期：2010-01-11
* ----------------修改日志-------------------------
* 修改人修改日期修改内容
* 小天2010-01-15添加根据任意字段查询的方法
----------------------------------------------------------------------------------*/
using System;
using System.Data;
{
///<summary>
///导游等级星业务类。
///</summary>
publicclassGuide_Star
{
//这是第二种注释方式，对单句的注释
privatereadonly LonelyBag.DAL.Guide_Star dal=new LonelyBag.DAL.Guide_Star();
public Guide_Star()
{}
成员方法代码
}
}
另一个添加注释的方法是用"//"开始一个注释，其后可以编写任何内容，只要这些内容在一行上即可。下面的语句是正确的，例如上面代码中
//这是第二种注释方式，对单句的注释
使用这种注释是不可换行的，例如下面的语句会失败，因为第二行代码会解释为C#代码：
//这是第二种注释方式，
对单句的注释
这类注释可用于对单独一行C#语句的说明，因为它们都放在一行上：
小天：在你上面的实例中，我还看到这注释，是什么意思？
///<summary>
///导游等级星业务类。
///</summary>
老田：这是C#的第三类注释，严格地说，这是//语法的扩展。它们都是单行注释，用三个"/"符号来开头，而不是两个。
这种方式主要用于对类和类成员进行描述，而使用起来比第一种（前后用/* */）还要简单。将光标放在需要加这种注释的地方，连续敲击三个"/"即可。如果是对类描述就会生成上面那种形式，如果是对方法的就则自动根据方法的参数和返回类型等生成更详细的注释格式。
在正常情况下，编译器会忽略它们，就像其它注释一样，但可以配置VS，在编译项目时，提取这些注释后面的文本，创建一个特殊格式的文本文件，该檔可用于创建文檔说明书。
小天：上面尖括号中那个summary是什么意思？
老田：这个是这一类注释的XML标记，下表说明这一类XML标记以及其作用
标记 说明
<c> 把行中的代码标记为代码，例如<c> if(i>=10);</c>
<code> 把多行标记为代码
<example> 标记为一个代码示例
<exception> 说明一个异常类
<include> 包含其它文檔说明文件的注释
<list> 把列表插入到文檔说明中
<para> 标记方法的参数
<param> <param name='name'>description</param>
Name是方法中参数的名称，description是参数的说明
<paramref> 表示一个单词是方法的参数
<permission> 说明对成员的访问
<remarks> 给成员添加描述
<returns> 说明方法的返回值
<see> 提供对另一个参数的交叉引用
<seealso> 提供描述中的"参见"部分
<summary> 提供类型或者成员的简短小结
<typeparam> 文本将显示在对象浏览器代码注释 Web 报表的 IntelliSense 中。
<typeparam name="name">description</typeparam>
Name是参数名，description是参数说明
<typeparamref> 文檔檔的使用者能够以某种独特的方式设置单词的格式，例如以斜体显示。
<typeparamref name="name"/>
Name是类型参数的名称
<value> 描述属性
接下来我们具体的示例，下面示例中除灰色的符号和字体都是由"在方法体上连续敲三个"/"后"自动生成的，所以不用觉得太多。
///<summary>
///对这个方法的简要说明
///</summary>
///<param name="min">参数min的说明</param>
///<param name="max">参数max的说明</param>
///<returns>返回值的描述</returns>
publicint GetCount(int min, int max)
{
//逗你玩
}
本文为天轰穿原著，转载请注明出处及作者！
