7.3-04 软件编码规则.docx

软件编码规则

QMI-7.3-04

受控状态：FORMCHECKBOX受控FORMCHECKBOX非受控

版本号：A/00

发放编号：

编写/日期

审核/日期

批准/日期

软件编码规则

文件编号

QMI-7.3-04

版本号

A/00

共SECTIONPAGES\*Arabic19页第PAGE2页

文件修改控制页

序号

版本

更改内容概述

编制人/日期

审核人/日期

批准人/日期

1

A/00

初次编制

TOC\o1-2\h\z\u

目的

本规范为一套编写高效可靠的C#代码的标准、约定和指南。它以安全可靠的软件工程原则为基础，使代码易于理解、维护和增强，提高生产效率。同时，将带来更大的一致性，使软件开发团队的效率明显提高。

范围

本规定适用于公司医疗器械软件组件的C#源代码，为详细设计，代码编写和代码审核提供参考和依据。

文体

依据约束力强弱及故障敏感性，规约依次分为【强制】、【推荐】、【参考】三大类。。在延伸信息中，“说明”对规约做了适当扩展和解释。

命名风格

4.1【强制】代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束。

4.2【强制】所有编程相关的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。

说明：正确的英文拼写和语法可以让阅读者易于理解，避免歧义。注意，纯拼音命名方式更要避免采用。

4.3【强制】代码和注释中都要避免使用任何语言的种族歧视性词语。

4.4【强制】类名使用UpperCamelCase风格，但以下情形例外：DO/BO/DTO/VO/AO/PO/UID等。

4.5【强制】方法名、参数名、成员变量、局部变量都统一使用lowerCamelCase风格。

4.6【强制】常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。

4.7【强制】抽象类命名使用Abstract或Base开头；异常类命名使用Exception结尾；测试类命名以它要测试的类的名称开始，以Test结尾。

4.8【强制】类型与中括号紧挨相连来表示数组。

4.9【强制】POJO类中的任何布尔类型的变量，都不要加is前缀，否则部分框架解析会引起序列化错误。

说明：在本文MySQL规约中的建表约定第一条，表达是与否的变量采用is_xxx的命名方式，所以，需要在resultMap设置从is_xxx到xxx的映射关系。

4.10【强制】包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式，但是类名如果有复数含义，类名可以使用复数形式。

4.11【强制】避免在子父类的成员变量之间、或者不同代码块的局部变量之间采用完全相同的命名，使可理解性降低。

说明：子类、父类成员变量名相同，即使是public类型的变量也能够通过编译，另外，局部变量在同一方法内的不同代码块中同名也是合法的，这些情况都要避免。对于非setter/getter的参数名称也要避免与成员变量名称相同。

4.12【强制】杜绝完全不规范的缩写，避免望文不知义。

4.13【推荐】为了达到代码自解释的目标，任何自定义编程元素在命名时，使用尽量完整的单词组合来表达。

4.14【推荐】在常量与变量的命名时，表示类型的名词放在词尾，以提升辨识度。

4.15【推荐】如果模块、接口、类、方法使用了设计模式，在命名时需体现出具体模式。

说明：将设计模式体现在名字中，有利于阅读者快速理解架构设计理念。

4.16【推荐】接口类中的方法和属性不要加任何修饰符号（public也不要加），保持代码的简洁性，并加上有效的Javadoc注释。尽量不要在接口里定义变量，如果一定要定义变量，确定与接口方法相关，并且是整个应用的基础常量。

4.17接口和实现类的命名有两套规则：

1）【强制】对于Service和DAO类，基于SOA的理念，暴露出来的服务一定是接口，内部的实现类用Impl的后缀与接口区别。

2）【推荐】如果是形容能力的接口名称，取对应的形容词为接口名（通常是–able的形容词）。

4.18【参考】枚举类名带上Enum后缀，枚举成员名称需要全大写，单词间用下划线隔开。

说明：枚举其实就是特殊的常量类，且构造方法被默认强制是私有。

4.19【参考】各层命名规约：

A)Service/DAO层方法命名规约

1）获取单个对象的方法用get做前缀。

2）获取多个对象的方法用list做前缀，复数结尾，如：listObjects。

3）获取统计值的方法用count做前缀。

4）插入的方法