JAVA开发规范V1.2.doc.doc

文思海辉技术有限公司 JAVA开发规范文档 2016年06月 目 录 1 绪论 1 1.1 目的 1 1.2 范围 1 1.3 版权声明 1 1.4 概述 1 2 代码组织与风格 2 2.1 基本原则 2 2.2 缩进 2 2.3 长度 2 2.4 行宽 3 2.5 间隔 3 2.6 对齐 3 2.7 括号 4 3 注释 4 3.1 基本原则 4 3.2 JavaDoc 4 3.3 文件与包注释 4 3.4 类与方法注释 5 3.5 其他注释 6 3.6 注释参考表 7 4 命名 8 4.1 基本原则 8 4.2 文件、包 9 4.3 类、接口 9 4.4 字段 9 4.4.1 常量 9 4.4.2 变量和参数 9 4.4.3 组件/部件 10 4.4.4 集合 10 4.4.5 神秘的数 10 4.4.6 其他 10 4.5 方法 11 4.6 异常 11 4.7 命名约定表 11 5 声明 13 5.1 基本原则 13 5.2 包 13 5.3 类、接口 13 5.4 方法 13 5.5 字段 14 5.6 示例 15 6 类与接口 17 6.1 基本原则 17 6.2 抽象类与接口 17 6.3 继承与组合 17 6.4 构造方法和静态工厂方法 17 6.5 toString() 18 6.6 Singleton Class 19 7 方法 19 7.1 基本原则 19 7.2 参数和返回值 20 7.3 输入参数合法性判断原则 21 8 表达式与语句 22 8.1 基本原则 22 8.2 控制语句 23 8.3 循环语句 27 9 错误与异常 28 9.1 基本原则 28 9.2 已检查异常与运行时异常 28 9.3 异常的传递 29 9.4 异常处理规范 30 9.5 异常处理范例 31 9.6 异常捕获 31 9.6.1 异常捕获位置 31 9.6.2 异常处理方法 32 10 性能与安全 32 10.1 基本原则 32 10.2 String与StringBugffer 32 10.3 确定 StringBuffer的容量 33 10.4 集合 33 10.5 对象 34 10.6 同步 34 10.7 final 34 10.8 垃圾收集和资源释放 35 10.9 使用‘System.arraycopy ()‘代替通过来循环复制数组 35 11 附录 37 11.1 常用缩写简表 37 绪论 目的 本规范的目的是使本组织能以标准的、规范的方式设计和编码。通过建立编码规范，以使每个开发人员养成良好的编码风格和习惯；并以此形成开发小组编码约定，提高程序的可靠性、可读性、可修改性、可维护性和一致性等，增进团队间的交流，并保证软件产品的质量。 版权声明 未经原作者授权，任何个人、组织或单位不得将本文档用于书面发表、转载、摘录等，亦不得用于其他商业行为。 概述 一个软件的生命周期中，80%的在于维护几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护编码规范可以改善软件的可读性，可以让员尽快而彻底地理解新的代码如果将源码作为产品发布，就需要它是否被很好的打包并且清晰无误public void methodName(){ if(some condition){ for(…){ //some sentences }//end for }//end if } 长度 为便于阅读和理解，单个方法的有效代码长度必须控制在100行以内（包括注释行、减少方法内简单代码的注释），当一个功能模块过大时往往造成阅读困难，因此当使用子方法等将相应功能抽取出来，这也有利于提高代码的重用度。 单个类也不宜过大，当出现此类情况时当将相应功能的代码重构到其他类中，通过组合等方式来调用，建议单个类的长度包括注释行不能超过1500行。 尽量避免使用大类和长方法。 行宽 页宽应该设置为120字符，不能超过这个宽度, 这会导致在某些机器中无法以一屏来完整显示。在任何情况下, 超长的语句应该在一个逗号后或一个操作符前折行。一条语句折行后, 应该比原来的语句再缩进一个TAB或4个空格，以便于阅读。 间隔 类、方法及功能块间等应以空行相隔，以增加可读性，但不得有无规则的大片空行。CheckStyle默认检查超过8行的空行和空语句块。 操作符两端应当各空一个字符以增加可读性。 相应独立的功能模块之间可使用注释行间隔，并标明相应内容，具体参看附录的代码示例。 对齐 关系密切的行应左对齐，换行后按照缩进格式执行。 对齐示例 //变量对齐---- int count = 100; int length = 0; String strU