编码规范V100

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

1、编号：GF_Code_V1.0.0C#编码规范保密级别：保密文件状态[]草稿文件[√]正式文件[]更改正式文件文件标识：GF_Code_V1.0当前版本：V1.0.0作者：谢换青审核：完成日期：2011-11-1124/24版本历史版本/状态作者参与者起止日期备注V1.0.0谢换青2011-09-10至2011-11-1124/24目录1文档描述51.1目的51.2读者对象51.3适用范围51.4定义52编程准则52.1变量使用52.2数据库操作62.3对象使用62.4结构化要求62.5函数返回值原则72.6关键字使用原则72.7架构使用原则73编码规则73.1错

2、误检查规则73.2大括号规则83.3缩进规则93.4IfThenElse规则93.5Switch…Case…规则103.6单语句规则103.7单一功能规则103.8独立赋值规则103.9模块化规则103.10交流规则114命名规范114.1命名规范114.2变量（Variable）命名114.3常量（const）命名144.4类（Class）命名1424/244.5接口（Interface）命名154.6方法（Method）命名154.7命名空间（NameSpace）命名155注释规范155.1概述155.2自建代码文件注释165.3模块（类）注释165.4类属性

3、注释175.5方法注释175.6代码间注释176代码包的版本号186.1代码包的标识187输入控制校验规则198附件198.1控件缩写前缀19124/241引言1.1目的为了统一公司软件开发的设计过程中关于代码编写时的编写规范和具体开发工作时的编程规范，保证代码的一致性，便于交流和维护，特制定此规范。1.2读者对象参与本项目开发工作的软件工程师1.3适用范围软件项目开发的代码编写阶段和后期维护阶段。1.4定义灰色字体表示部分为优先原则，非必行约定。蓝色字体表示部分为代码演示部分。绿色字体表示部分为代码注释演示部分。格式描述中，符号[]表示必选元素。格式描述中，符号

4、()表示可选元素。2编程准则2.1变量使用a) 一个变量只能有一个用途；变量的用途必须和变量的名称保持一致。b) 所有变量都必须在类和函数最前面定义，并分类排列。24/241.1数据库操作a)  查找数据库表或视图时，只能取出确实需要的那些字段。b)  使用无关联子查询，而不要使用关联子查询。c)  清楚明白地使用列名，而不能使用列的序号。d)  用事务保证数据的完整性。1.2对象使用a)尽可能晚地创建对象，并且尽可能早地释放它。b)关于对象的创建，尽量使用工厂模式集中生产。1.3结构化要求a)   禁止出现两条等价的支路。例如：if(a==2)         

5、   //      elseif(a==3)            //      elseif(a==2)            //      else          //  b) 避免使用GOTO语句c) 用IF语句来强调只执行两组语句中的一组。尽量不使用ELSEGOTO和ELSERETURN。d)用Switch…Case…实现多路分支，避免使用多IF嵌套e)避免从循环引出多个出口。f)函数只有一个出口。24/24g)在同一个类中读写数据源数据要保持一致如：classhello{    privatestring_Name;publicstringNa

6、me{Get{return_Name;}Set{_Name=value;}}PublicstringGetName(){//这里应该读写Name属性应该统一为this.Name而不是_NameIf(!string.isNullOrEmpty(this.Name)){Returnstring.format(“Mynameis{0}”,this.Name);}}}1.1函数返回值原则1） 函数返回值避免使用结构体等复杂类型24/241.1关键字使用原则1）partial关键字必需只作用于同一架构层上（在不同架构层上需要实现同一个类功能的，使用继承）2）partial关

7、键字最好只作用于同一命名空间上1.2架构使用原则1）低层类不允许使用高层类2）低层类库不允许引用高层类库2编码规则2.1错误检查规则a) 编程中要考虑函数的各种执行情况，尽可能处理所有流程情况。b) 检查所有的系统调用的错误信息，除非要忽略错误。c) 将函数分两类：一类为与屏幕的显示无关，另一类与屏幕的显示有关。对于与屏幕显示无关的函数，函数通过返回值来报告错误。对于与屏幕显示有关的函数，函数要负责向用户发出警告，并进行错误处理。d) 错误处理代码一般放在函数末尾。e) 对于通用的错误处理，可建立通用的错误处理函数，处理常见的通用的错误。f)异常必须有效处理，如果

8、不能有效处