编码规范V1.0.0.docVIP

编号：GF_Code_V1.0.0 C#编码规范 保密级别：保密 文件状态 [ ] 草稿文件 [√] 正式文件 [ ] 更改正式文件 文件标识： 当前版本： V 作 者： 审 核： 完成日期： 版本历史 版本/状态 作者 参与者 起止日期 备注 V 2011-09-10至2011-11-11 目 录 1 文档描述 5 1.1 目的 5 1.2 读者对象 5 1.3 适用范围 5 1.4 定义 5 2 编程准则 5 2.1 变量使用 5 2.2 数据库操作 6 2.3 对象使用 6 2.4 结构化要求 6 2.5 函数返回值原则 7 2.6 关键字使用原则 7 2.7 架构使用原则 7 3 编码规则 7 3.1 错误检查规则 7 3.2 大括号规则 8 3.3 缩进规则 9 3.4 If Then Else规则 9 3.5 Switch… Case…规则 10 3.6 单语句规则 10 3.7 单一功能规则 10 3.8 独立赋值规则 10 3.9 模块化规则 10 3.10 交流规则 11 4 命名规范 11 4.1 命名规范 11 4.2 变量（Variable）命名 11 4.3 常量（const）命名 14 4.4 类（Class）命名 14 4.5 接口（Interface）命名 15 4.6 方法（Method）命名 15 4.7 命名空间（NameSpace）命名 15 5 注释规范 15 5.1 概述 15 5.2 自建代码文件注释 16 5.3 模块（类）注释 16 5.4 类属性注释 17 5.5 方法注释 17 5.6 代码间注释 17 6 代码包的版本号 18 6.1 代码包的标识 18 7 输入控制校验规则 19 8 附件 19 8.1 控件缩写前缀 19 引言 目的 为了统一公司软件开发的设计过程中关于代码编写时的编写规范和具体开发工作时的编程规范，保证代码的一致性，便于交流和维护，特制定此规范。 读者对象 参与本项目开发工作的软件工程师 适用范围 软件项目开发的代码编写阶段和后期维护阶段。 定义 灰色字体表示部分为优先原则，非必行约定。 蓝色字体表示部分为代码演示部分。 绿色字体表示部分为代码注释演示部分。 格式描述中，符号[]表示必选元素。 格式描述中，符号()表示可选元素。 编程准则 变量使用 a)?一个变量只能有一个用途；变量的用途必须和变量的名称保持一致。 b)?所有变量都必须在类和函数最前面定义，并分类排列。 数据库操作 a)?? 查找数据库表或视图时，只能取出确实需要的那些字段。 b)?? 使用无关联子查询，而不要使用关联子查询。 c)?? 清楚明白地使用列名，而不能使用列的序号。 d)?? 用事务保证数据的完整性。 对象使用 尽可能晚地创建对象，并且尽可能早地释放它。 关于对象的创建，尽量使用工厂模式集中生产。 结构化要求 a)???禁止出现两条等价的支路。 例如：if (a == 2) ???????????? // ?????? else if (a== 3) ???????????? // ?????? else if (a == 2) ???????????? // ?????? else ?????????? //?? b)?避免使用GOTO语句 c)?用 IF 语句来强调只执行两组语句中的一组。尽量不使用 ELSE GOTO 和 ELSE RETURN。 d) 用Switch… Case…实现多路分支，避免使用多IF嵌套 e) 避免从循环引出多个出口。 f) 函数只有一个出口。 g)在同一个类中读写数据源数据要保持一致 如： class hello { ????private string _Name; public string Name { Get{return _Name;} Set{_Name=value;} } Public string GetName() { //这里应该读写Name属性应该统一为this.Name而不是_Name If(!string.isNullOrEmpty(this.Name)) { Return string.format(“My name is {0}”, this.Name); } } } 函数返回值原则 1）? 函数返回值 避免使用结构体等复杂类型 关键字使用原则 partial关键字必需只作用于同一架构层上（在不同架构层上需要实现同一个类功能的，使用继承） partial关键字最好只作用于同一命名空间上 架构使用原则 低层类不允许使用高层类 低层类库不允