对C#.NET编程规范的个人见解

作者：Eunge

邮箱：[e-mail]

我们应该知道编程规范对于项目的生命周期多么重要，如果每个程序员写的代码都令其他人难以阅读、或者一个团队项目的代码却五花八门，这样的项目将会是怎么样的噩梦。

MS为提供了FXCop工具，用于自动检查代码的规范性、安全性和效率，所以，本文将围绕MS提供的C#.NET代码规范展开。

FXCop工具下载地址：http://www.gotdotnet.com/team/fxcop

1、命名约定

Pascal和Camel命名约定

编程的命名方式主要有Pascal和Camel两种（Pascal：每个单词的首字母大写，例如ProductType；Camel：首个单词的首字母小写，其余单词的首字母大写，例如productType）

以下是一些常用的C#成员及其推荐命名方法：

标志符	规则	实例与描述
类class	Pascal	Application
枚举类型enum	Pascal	记住，是以Pascal命名，切勿包含Enum，否则FXCop会抛出Issue
委托delegate	Pascal	以Pascal命名，不以任何特殊字符串区别于类名、函数名
常量const	全部大写	全部大写，单词间以下划线隔开
接口interface	Pascal	IDisposable 注：总是以 I 前缀开始，后接Pascal命名
方法function	Pascal	ToString
命名空间namespace	Pascal	以.分隔，当每一个限定词均为Pascal命名方式，比如： using ExcelQuicker.Framework
参数	Camel	首字母小写
局部变量	Camel	也可以加入类型标识符，比如对于System.String类型，声明变量是以str开头，string strSQL = string.Empty;
数据成员	Camel	以m开头＋Pascal命名规则，如mProductType（m意味member）
属性	Pascal

1.1、局部变量命名

在primitive的局部变量命名时，使用Camel命名规则，

比如：int type = 0;

double count = 0;

…

对于string类型定义，通常使用str前缀＋Pascal命名的方式，

比如string strSql = ""; //这是一种典型的命名SQL语句字符串的方式。

而对于此外的类型对象定义，通常的做法是使用obj前缀＋Pascal命名的方式，来告知我们这个变量是一个对象。或者也可以直接使用类名的Camel命名规则。

比如：Application objApplication = new Application();
Application application = new Application();

1.2、参数命名

Camel命名规则，首字母小写

1.3、类数据成员/属性命名

数据成员命名以Camel命名方式，而属性以Pascal命名。通常如果数据成员与属性成对的话，数据成员与属性的命名区别仅在于变量名的第一个字母是小写还是大写。

比如

class Appcalition

{

private ArrayList worksheetCollection = new ArrayList();

public ArrayList WorksheetCollection

{

get

{

return this.worksheetCollection;

}

}

}

另外，类的成员数据/方法调用时，应该加上this限定符，this在编辑环境中是蓝色的，更利于我们区分局部变量、参数或静态变量，并且利于FXCop检测区分。（如果使用FxCop扫描和检测代码的话）

1.4、命名空间命名

在dot之间的各限定字符串符合Pascal格式

1.5、委托缩写

委托的命名方式我常常以Pascal命名，并且在命名的后面加EventHandler

比如public delegate void MouseEventHandler (object sender, MouseEventArgs e); //用于处理与鼠标相关的事件或委托

对于自定义的委托，其参数第一个建议仍然使用object sender，sender代表触发这个时间或委托的源对象。而第二个参数继承于EventArgs类，并且在派生类中实现自己的业务逻辑。

1.6、自定义异常类

自定义异常类以Exception结尾，并且在类名中能清楚的描述出该异常的原因。比如NotFoundFileException，描述出了某个实体（文件、内存区域等）无法被找到。

1.7、枚举

枚举的命名是Pascal命名，不需要在枚举中加入Enum，枚举的名称能清楚的表明该枚举的用途。

1.8、常量命名

全部大写，单词间并且以下划线间隔，如public const int LOCK_SECONDS = 3000; 虽然在MSDN中常量的命名推荐使用Pascal，但是从C++沿袭的命名规则来看，将常量全部大写更加能清楚的表示常量与普通变量之间的区别。

1.9、命名缩写

在一般情况下，不推荐缩写命名，不要担心变量命名长，长的变量名能使变量的意义更加清晰，其实从长变量名的负面作用三，因为Ctrl+C和Ctrl+V加上在VS中的智能感知，其负面追用已经很小。变量命名的原则是，尽最大努力让其他人在看到我们的变量/函数/…等的第一时间，大概能猜出它是做什么的。

比如：int productTypeCount = 0; //我们在第一时间就能知道它是记录产品的数量的变量

而对于糟糕的命名方式：int prodTypeCount = 0; //它是productTypeCount的简写，我们一部分人也许知道prod是product的缩写，但是每人能保证所有的人都知道它。我个人认为：最优秀的代码它本身就是注释。作为一流的程序员。并不仅仅实现功能，而是要让我们的代码更加优美，具备让他人维护或今后扩充的能力。作为现在的业务系统，其门槛的准入水平已大大降低，实现功能上的需求已没有什么难度，但是高手和菜鸟的区别在于，高手的代码通俗易懂，在整个编码的过程中，不仅能考虑到性能、还会考虑代码可读性和维护性。

1.10、数据库命名

数据库的字段、表名的命名都推荐采用Pascal命名方式，尽量不采用缩写。当然，使用长的字段名、表名，可能会使SQL语句的编写带来负面影响。我推荐大家可以使用一些ORM，ORM的性能肯定不会比直接写SQL的好，但是如果做业务系统，更重要的是系统多久能交付用户使用，ORM不仅使开发时间可以缩短不少，并且在后期的维护上也比直接写SQL便利很多。

2、注释规范

2.1、文件头部注释

在代码文件的头部进行注释，这样做的好处在于，我们能对代码文件做变更跟踪。在代码头部分标注出创始人、创始时间、修改人、修改时间、代码的功能，这在团队开发中必不可少，它们可以使后来维护/修改的同伴在遇到问题时，在第一时间知道他应该向谁去寻求帮助，并且知道这个文件经历了多少次迭代、经历了多少个程序员的开发和修改。

样本：

/********************************************************************************

** 作者： Eunge

** 创始时间：<chsdate w:st="on" year="2004" month="6" day="8" islunardate="False" isrocdate="False">2004-6-8</chsdate>

** 修改人：Lucy

** 修改时间：<chsdate w:st="on" year="2004" month="12" day="9" islunardate="False" isrocdate="False">2004-12-9</chsdate>

** 修改人：Lucy

** 修改时间：<chsdate w:st="on" year="2005" month="1" day="29" islunardate="False" isrocdate="False">2005-01-29</chsdate>

** 描述：

** 主要用于产品信息的资料录入，…

*********************************************************************************/

2.2、函数、属性、类等注释

请使用///三斜线注释，这种注释是基于XML的，不仅能导出XML制作帮助文档，而且在各个函数、属性、类等的使用中，编辑环境会自动带出注释，方便你的开发。以protected，protected Internal，public声明的定义注释都建议以这样命名方法。

例如：

/// <summary>

/// 用于从ERP系统中捞出产品信息的类

/// </summary>

class ProductTypeCollector

{

…

}

2.3、逻辑点注释

在我们认为逻辑性较强的地方加入注释，说明这段程序的逻辑是怎样的，以方便我们自己后来的理解以及其他人的理解，并且这样还可以在一定程度上排除BUG。在注释中写明我们的逻辑思想，对照程序，判断程序是否符合我们的初衷，如果不是，则我们应该仔细思考耀修改的是注释还是程序了…

3、排版

我的排版原则与建议：

1、 每行语句至少占一行，如果语句过长（超过一屏），则该语句断为两行显示；

2、 把相似的内容放在一起，比如数据成员、属性、方法、事件等，并适当的使用#region…#endregion，我最喜欢把机器生成的代码都放在一个#region里面，比如在编写ASP.NET程序时，对应自动产生的控件定义，我常用#region Automatic Generated Web Components … #endregion把他们框住

3、 使用空格，

（1） 双目操作符的前后加空格(+, =, && 等)，index = index + 1;

（2） 单目操作符前加空格(!, ++, ~ 等)， index ++;

（3） 逗号、分号只在后面加空格

4、 使用空行，在一段功能代码、或者函数、属性之间插入空行，这样会很直观。

在Visual Studio 2005中，其实已经带有代码格式化这样的功能，快捷键是Ctrl+K -> Ctrl+D。

4、界面控件命名

我的建议是使用默认控件名作为前缀，前缀名称全部小写，这样的好处是不必为未知的控件统一命名方式发愁，比如对于Label标签控件，有的人用缩写lbl，有的人用lab，有的人用lb。这样其实仍然是避免使用缩写，有的时候仍然会使命名变得冗长，但是命名更加能反应出变量的意义，并且各个开发人员也能更好的执行，因为他们不需要去背记各个变量的缩写。

protected System.Web.UI.WebControls.Button buttonQuery;

protected System.Web.UI.WebControls.DropDownList dropdownlistProductType;

protected System.Web.UI.WebControls.TextBox textboxManufactureDate;

5、代码可读性一些建议

（1）注意运算符的优先级，我们应该尽量使用括号明确表达式的操作顺序，避免使用默认优先级，给我们以及维护人带来困扰

（2）避免使用不易理解的数字，用有意义的标识来替代（枚举和常量）

比如：

if(productType == 0) … else if (productType == 1) … （不推荐使用）

if(productType == ProductType.CD) … else if (productType == ProductType.DVD) … （推荐使用）

（3）在界面层中尽量使用异常处理try语句，不要将系统级别的错误直接暴露给用户，而更应该的是把系统抛出的错误信息记录到LOG日志文件中去，告诉用户友好的提示信息

在Visual Studio 2005里面，有代码布局格式化功能，蛮有用的。其实代码的规范是为了使系统具有整体一致的编码风格，以使后期维护人员能更快的读懂代码并进行维护。我认为代码规范有其必要性，但不能因为规范而规范，从开发而言，开发是为了更快的做出稳定的系统，而稳定的系统是为了给公司带来受益。开发人员、项目管理人员都应该更多的从项目经营的角度出来，同时站在公司、客户的角度考虑问题，而不是因为代码而代码。

来自:http://www.cnblogs.com/lovinger2000/archive/2005/06/27/CSharpCodeStandard.html

此外,提供一示例,给示例来自:http://www.cnblogs.com/name-lh/archive/2007/04/28/731528.html,我摘取了其中的片段来展示.

namespaceSystem.Net.Ftp
{
///<summary>
///FTP处理操作类
///功能：
///下载文件
///上传文件
///上传文件的进度信息
///下载文件的进度信息
///删除文件
///列出文件
///列出目录
///进入子目录
///退出当前目录返回上一层目录
///判断远程文件是否存在
///判断远程文件是否存在
///删除远程文件
///建立目录
///删除目录
///文件（目录）改名

///</summary>
///<remarks>
///创建人：南疯
///创建时间：2007年4月28日
///</remarks>

文件信息结构#region文件信息结构
publicstructFileStruct
{
publicstringFlags;
publicstringOwner;
publicstringGroup;
publicboolIsDirectory;
publicDateTimeCreateTime;
publicstringName;
}
publicenumFileListStyle
{
UnixStyle,
WindowsStyle,
Unknown
}
#endregion
publicclassclsFTP
{
#region属性信息
///<summary>
///FTP请求对象
///</summary>
FtpWebRequestRequest=null;
///<summary>
///FTP响应对象
///</summary>
FtpWebResponseResponse=null;
publicUriUri
{
get
{
if(_DirectoryPath=="/")
{
return_Uri;
}
else
{
stringstrUri=_Uri.ToString();
if(strUri.EndsWith("/"))
{
strUri=strUri.Substring(0,strUri.Length-1);
}
returnnewUri(strUri+this.DirectoryPath);
}
}
set
{
if(value.Scheme!=Uri.UriSchemeFtp)
{
thrownewException("Ftp地址格式错误!");
}
_Uri=newUri(value.GetLeftPart(UriPartial.Authority));
_DirectoryPath=value.AbsolutePath;
if(!_DirectoryPath.EndsWith("/"))
{
_DirectoryPath+="/";
}
}
}

#region构造析构函数
///<summary>
///构造函数
///</summary>
///<paramname="FtpUri">FTP地址</param>
///<paramname="strUserName">登录用户名</param>
///<paramname="strPassword">登录密码</param>
publicclsFTP(UriFtpUri,stringstrUserName,stringstrPassword)
{
this._Uri=newUri(FtpUri.GetLeftPart(UriPartial.Authority));
_DirectoryPath=FtpUri.AbsolutePath;
if(!_DirectoryPath.EndsWith("/"))
{
_DirectoryPath+="/";
}
this._UserName=strUserName;
this._Password=strPassword;
this._Proxy=null;
}
///<summary>
///构造函数
///</summary>
///<paramname="FtpUri">FTP地址</param>
///<paramname="strUserName">登录用户名</param>
///<paramname="strPassword">登录密码</param>
///<paramname="objProxy">连接代理</param>
publicclsFTP(UriFtpUri,stringstrUserName,stringstrPassword,WebProxyobjProxy)
{
this._Uri=newUri(FtpUri.GetLeftPart(UriPartial.Authority));
_DirectoryPath=FtpUri.AbsolutePath;
if(!_DirectoryPath.EndsWith("/"))
{
_DirectoryPath+="/";
}
this._UserName=strUserName;
this._Password=strPassword;
this._Proxy=objProxy;
}
#endregion

推荐微软的命名规范:

http://msdn2.microsoft.com/en-us/library/xzf533w0(vs.71).aspx