开发设计规范概要.docx

技术开发规范 ［初稿］ 北京中科天擎信息技术有限公司 2016年11月12日  目录 一、 JAVA代码规范 3 1. 标识符命名规范 3 1.1 概述 3 1.2 包名 4 1.3 类名 4 1.4 方法名 5 1.5 域（field）名 7 1.6 局部变量名 8 2. 代码格式 8 2.1 源文件编码 8 2.2 行宽 8 2.3 包的导入 8 2.4 类格式 8 2.5 域格式 8 2.5 方法格式 9 2.6 代码块格式 9 3. 注释规范 11 3.1 注释 vs 代码 11 3.2 Java Doc 12 3.3 块级别注释 12 3.4 行内注释 14 4 最佳实践和禁忌 14 4.1 每次保存的时候，都让你的代码是最美的 14 4.2 使用log而不是System.out.println() 14 4.3 每个if while for等语句，都不要省略大括号{} 14 4.4 善用TODO: 15 4.5 在需要留空的地方放一个空语句或注释，告述读者，你是故意的 15 4.6 不要再对boolean值做true false判断 15 4.7 减少代码嵌套层次 16 4.8 程序职责单一 17 4.9 变量的声明，初始化和被使用尽量放到一起 17 4.10 缩小变量的作用域 18 4.11 尽量不要用参数来带回方法运算结果 19 二、 数据库表及字段命名规范 20 1.数据库表命名规范: 20 2.表字段命名规范： 20 3.表设计规范： 21 4.存储过程命名规范 22 5.存储过程设计规范 23 6.视图命名规范 23 7.视图设计规范 23 8.触发器命名规范 24 9.触发器设计规范 24  一、 JAVA代码规范 Java代码规范以SUN的标准Java代码规范为基础，本文档中没有说明的地方，请参看SUN Java标准代码规范。如果两边有冲突，以本文档为准。 1. 标识符命名规范 1.1 概述 标识符的命名力求做到统一、达意和简洁。 1.1.1 统一 统一是指，对于同一个概念，在程序中用同一种表示方法，比如对于供应商，既可以用supplier，也可以用provider，但是我们只能选定一个使用，至少在一个Java项目中保持统一。统一是作为重要的，如果对同一概念有不同的表示方法，会使代码混乱难以理解。即使不能取得好的名称，但是只要统一，阅读起来也不会太困难，因为阅读者只要理解一次。 1.1.2 达意 达意是指，标识符能准确的表达出它所代表的意义，比如： newSupplier, OrderPaymentGatewayService等；而 supplier1, service2，idtts等则不是好的命名方式。准确有两成含义，一是正确，而是丰富。如果给一个代表供应商的变量起名是 order，显然没有正确表达。同样的，supplier1, 远没有targetSupplier意义丰富。 1.1.3 简洁 简洁是指，在统一和达意的前提下，用尽量少的标识符。如果不能达意，宁愿不要简洁。比如：theOrderNameOfTheTargetSupplierWhichIsTransfered 太长， transferedTargetSupplierOrderName则较好，但是transTgtSplOrdNm就不好了。省略元音的缩写方式不要使用，我们的英语往往还没有好到看得懂奇怪的缩写。 1.1.4 骆驼法则 Java中，除了包名，静态常量等特殊情况，大部分情况下标识符使用骆驼法则，即单词之间不使用特殊符号分割，而是通过首字母大写来分割。比如: SupplierName, addNewContract，而不是 supplier_name, add_new_contract。 1.1.5 英文 vs 拼音 尽量使用通俗易懂的英文单词，如果不会可以向队友求助，实在不行则使用汉语拼音，避免拼音与英文混用。比如表示归档，用archive比较好, 用pigeonhole则不好，用guiDang尚可接受。 1.2 包名 使用小写字母如?mon.settlment，不要?mon.Settlement单词间不要用字符隔开，比如?mon.settlment.jsfutil，而不要mon.settlement.jsf_util 1.3 类名 1.3.1 首字母大写 类名要首字母大写，比如 SupplierService, PaymentOrderAction；不要 supplierService, paymentOrderAction. 1.3.2 后缀 类名往往用不同的后缀表达额外的意思，如下表： 后缀名 意义 举例 Service 表明这个类是个服务类，里面包含了给其他类提同业务服务的方法 PaymentOrderService