开发设计规范.pdfVIP

技术开发规范 ［初稿］ 北京中科天擎信息技术有限公司 2016 年 11 月 12 日 目录 一、 JAVA 代码规范 6 1. 标识符命名规范 6 1.1 概述 6 1.2 包名 7 1.3 类名 7 1.4 方法名 8 1.5 域（ field ）名 10 1.6 局部变量名 11 2. 代码格式 . 11 2.1 源文件编码 11 2.2 行宽 11 2.3 包的导入 11 2.4 类格式 11 2.5 域格式 11 2.5 方法格式 12 2.6 代码块格式 12 3. 注释规范 . 14 3.1 注释 vs 代码 14 3.2 Java Doc 14 3.3 块级别注释 15 3.4 行内注释 17 4 最佳实践和禁忌 17 4.1 每次保存的时候，都让你的代码是最美的 17 4.2 使用 log 而不是 System.out.println() 17 4.3 每个 if while for 等语句，都不要省略大括号 {} 17 4.4 善用 TODO: 18 4.5 在需要留空的地方放一个空语句或注释，告述读者，你是故意的 18 4.6 不要再对 boolean 值做 true false 判断 19 4.7 减少代码嵌套层次 19 4.8 程序职责单一 20 4.9 变量的声明，初始化和被使用尽量放到一起 21 4.10 缩小变量的作用域 . 21 4.11 尽量不要用参数来带回方法运算结果 22 二、 数据库表及字段命名规范 23 1. 数据库表命名规范 : 23 2. 表字段命名规范： 24 3. 表设计规范： 24 4. 存储过程命名规范 25 5. 存储过程设计规范 26 6. 视图命名规范 26 7. 视图设计规范 27 8. 触发器命名规范 27 9. 触发器设计规范 27 一、 JAVA代码规范 Java 代码规范以 SUN的标准 Java 代码规范为基础，本文档中没有说明的地方，请参看 SUN Java 标准代码规范。如果两边有冲突，以本文档为准。 1. 标识符命名规范 1.1 概述 标识符的命名力求做到