《代码编写规范.docx》由会员分享，可在线阅读，更多相关《代码编写规范.docx（5页珍藏版）》请在三一办公上搜索。
1、代码编写规范代码编写规范 一 编写目的： 为了使编写代码具有可读性、可理解性、可维护性，对程序编写人员代码实行统一风格，使得程序代码能够以名称反映含义、以形式反映结构。 二 命名规则： Pascal和Camel命名约定： 编程的命名方式主要有Pascal和Camel两种 1) 标识符： 规则：Pascal和Camel 实例：ProductType、productType 2) 类class 规则：Pascal和Camel 实例：Application 3) 枚举类型 enum 规则：Pascal 实例与描述：记住，是以Pascal命名，切勿包含Enum，否则FXCop会抛出Issue 4) 委
2、托 delegate 规则：Pascal 实例与描述:以Pascal命名，不以任何特殊字符串区别于类名、函数名 5) 常量const 规则：全部大写 实例与描述:全部大写，单词间以下划线隔开 6) 接口interface 规则：Pascal 实例与描述: IDisposable 注：总是以I前缀开始，后接Pascal命名 7) 方法 function 规则：Pascal 实例与描述:ToString 8) 重命名空间 namespace 规则：Pascal 实例与描述:以.分隔，当每一个限定词均为Pascal命名方式，比如：usingExcelQuicker.Framework 9) 参数 规
3、则：Camel 实例与描述:首字母小写 10) 局部变量 规则：Camel 实例与描述: 也可以加入类型标识符，比如对于System.String类型，声明变量是以str开头，string strSQL = string.Empty; 11) 数据成员 规则：Camel 以m开头+Pascal命名 实例与描述: 如mProductType属性 12) 自定义异常类 自定义异常类以Exception结尾，并且在类名中能清楚的描述出该异常的原因。比如NotFoundFileException，描述出了某个实体无法被找到。 13) 命名缩写 在一般情况下，不推荐缩写命名，不要担心变量命名长，长的变量
4、名能使变量的意义更加清晰，其实从长变量名的负面作用三，因为Ctrl+C和Ctrl+V加上在VS中的智能感知，其负面追用已经很小。变量命名的原则是，尽最大努力让其他人在看到我们的变量/函数/等的第一时间，大概能猜出它是做什么的。 比如：int productTypeCount = 0; /我们在第一时间就能知道它是记录产品的数量的变量 而对于糟糕的命名方式：int prodTypeCount = 0; /它是productTypeCount的简写，我们一部分人也许知道prod是product的缩写，但是每人能保证所有的人都知道它。我个人认为：最优秀的代码它本身就是注释。作为一流的程序员。并不仅仅
5、实现功能，而是要让我们的代码更加优美，具备让他人维护或今后扩充的能力。作为现在的业务系统，其门槛的准入水平已大大降低，实现功能上的需求已没有什么难度，但是高手和菜鸟的区别在于，高手的代码通俗易懂，在整个编码的过程中，不仅能考虑到性能、还会考虑代码可读性和维护性。 14) 数据库命名： 数据库的字段、表名的命名都推荐采用Pascal命名方式，尽量不采用缩写。当然，使用长的字段名、表名，可能会使SQL语句的编写带来负面影响。我推荐大家可以使用一些ORM，ORM的性能肯定不会比直接写SQL的好，但是如果做业务系统，更重要的是系统多久能交付用户使用，ORM不仅使开发时间可以缩短不少，并且在后期的维护上
6、也比直接写SQL便利很多 三 代码编写命名规范： A. 每行语句至少占一行，如果语句过长，则该语句断为两行显示； B. 把相似的内容放在一起，比如数据成员、属性、方法、事件等，并适当的使用#region#endregion，在编写ASP.NET程序时，对应自动产生的控件定义，用#region Automatic Generated Web Components #endregion框住 C. 使用空格 a) 双目操作符的前后加空格(+, =, & 等)，index = index + 1; b) 单目操作符前加空格(!, +, 等)， index +; c) 逗号、分号只在后面加空格 D. 使用空行，在一段功能代码、或者函数、属性之间插入空行，这样很直观。 E. 代码可读性一些建议 I. 注意运算符的优先级，应该尽量使用括号明确表达式的操作顺序，避免使用默认优先级，给维护人带来困扰 II. 避免使用不易理解的数字，用有意义的标识来替代
