程序代码编写规范

《程序代码编写规范》由会员上传分享，免费在线阅读，更多相关内容在应用文档-天天文库。

1、XK-DN-2000-10-11-12请在这里输入公司名称文档编号产品版本密级XK-DN-2000-10-11-12V1.0产品名称：共页程序编写规范及约定(仅供内部使用)文档作者：_______________日期：___/___/___开发/测试经理：_______________日期：___/___/___项目经理：_______________日期：___/___/___请在这里输入公司名称版权所有不得复制XK-DN-2000-10-11-12目录程序编写规范及约定31编写目的32代码编写风格32.1单元风格32.2语句风格33命名规则33.1

2、命名约定33.1.1标志符33.1.2类class33.1.3枚举类型enum43.1.4委托delegate43.1.5常量const43.1.6接口interface43.1.7方法function43.1.8命名空间namespace43.1.9参数43.1.10局部变量53.1.11数据成员53.1.12自定义异常类53.1.13命名缩写53.1.14数据库命名53.2代码编写命名规范63.3界面常用控件命名约定63.4文件命名规范73.4.1文档文件命名73.4.2配置文件命名73.4.3程序文件命名7XK-DN-2000-10-11-12程

3、序编写规范及约定1编写目的为了使编写代码具有可读性、可理解性、可维护性，对程序编写人员代码实行统一风格，使得程序代码能够以名称反映含义、以形式反映结构。此文档可供程序代码编写人员及代码维护人员使用。2代码编写风格2.1单元风格2.2语句风格3命名规则3.1命名约定Pascal和Camel命名约定：编程的命名方式主要有Pascal和Camel两种（Pascal：每个单词的首字母大写，例如ProductType；Camel：首个单词的首字母小写，其余单词的首字母大写，例如productType）3.1.1标志符 规则：Pascal、Camel 实例与描述：

4、例子说明3.1.2类class 规则：Pascal 实例与描述：ApplicationXK-DN-2000-10-11-121.1.1枚举类型enum 规则：Pascal 实例与描述：记住，是以Pascal命名，切勿包含Enum，否则FXCop会抛出Issue1.1.2委托delegate 规则：Pascal 实例与描述：以Pascal命名，不以任何特殊字符串区别于类名、函数名1.1.3常量const 规则：全部大写 实例与描述：全部大写，单词间以下划线隔开1.1.4接口interface 规则：Pascal 实例与描述：IDisposable注：总是

5、以I前缀开始，后接Pascal命名1.1.5方法function 规则：Pascal 实例与描述：ToString1.1.6命名空间namespace规则：Pascal实例与描述：以.分隔，当每一个限定词均为Pascal命名方式，比如：usingExcelQuicker.Framework1.1.7参数 规则：Camel 实例与描述：首字母小写 XK-DN-2000-10-11-121.1.1局部变量 规则：Camel 实例与描述：也可以加入类型标识符，比如对于System.String类型，声明变量是以str开头，stringstrSQL=strin

6、g.Empty;1.1.2数据成员规则：Camel 以m开头＋Pascal命名实例与描述：如mProductType（m意味member）属性1.1.3自定义异常类自定义异常类以Exception结尾，并且在类名中能清楚的描述出该异常的原因。比如NotFoundFileException，描述出了某个实体（文件、内存区域等）无法被找到。1.1.4命名缩写在一般情况下，不推荐缩写命名，不要担心变量命名长，长的变量名能使变量的意义更加清晰，其实从长变量名的负面作用三，因为Ctrl+C和Ctrl+V加上在VS中的智能感知，其负面追用已经很小。变量命名的原则是

7、，尽最大努力让其他人在看到我们的变量/函数/…等的第一时间，大概能猜出它是做什么的。比如：intproductTypeCount=0;//我们在第一时间就能知道它是记录产品的数量的变量而对于糟糕的命名方式：intprodTypeCount=0;//它是productTypeCount的简写，我们一部分人也许知道prod是product的缩写，但是每人能保证所有的人都知道它。我个人认为：最优秀的代码它本身就是注释。作为一流的程序员。并不仅仅实现功能，而是要让我们的代码更加优美，具备让他人维护或今后扩充的能力。作为现在的业务系统，其门槛的准入水平已大大降低

8、，实现功能上的需求已没有什么难度，但是高手和菜鸟的区别在于，高手的代码通俗易懂，在整个编码的过