CSS_金审工程应用软件Java开发规范_文档编号：应用开发Java编码 55216337.docVIP

文档编号： 应用开发Java编码规范 （版本v1.0.0） 2018年3月27日 成文信息 主题词： java开发编码规范 作 者： 文档类别： 开发规范 审 核： 批 准： 文档性质： 正式稿 主 送： 存档日期： 抄 送： 发布日期： 变更信息 版本 原因 作者 日期 目录 目录 1 第一章 概述 1 1.1 编写目的 1 1.2 定义 1 1.3 参考资料 1 第二章 代码格式与风格 2 2.1 基本原则 2 2.2 缩进 2 2.3 长度 2 2.4 行宽 3 2.5 间隔 3 2.6 括号 3 第三章 注释 4 3.1 基本原则 4 3.2 JavaDoc 4 3.3 文件注释 4 3.4 类、接口注释 5 3.5 方法注释 5 3.6 其他注释 6 3.7 注释参考表 6 第四章 命名规范 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 第五章 声明 13 5.1 基本原则 13 5.1.1 包 13 5.1.2 类、接口 14 5.1.3 方法 14 5.1.4 字段 15 5.1.5 示例 16 第六章 类与接口 17 6.1 基本原则 17 6.2 抽象类与接口 18 6.3 继承与组合 18 6.4 构造函数和静态工厂方法 18 6.5 toString(),equals(),hashCode()... 19 6.6 Singleton Class 20 第七章 方法 21 7.1 基本原则 21 7.2 参数和返回值 21 第八章 表达式与语句 22 8.1 基本原则 22 8.2 控制语句 22 8.3 循环语句 24 第九章 错误与异常 24 9.1 基本原则 24 9.2 已检查异常与运行时异常 25 9.3 异常的捕捉与处理 25 第十章 性能与安全 26 10.1 基本原则 26 10.2 String与StringBugffer 26 10.3 集合 27 10.4 对象 27 10.5 同步 27 10.6 final 27 10.7 垃圾收集和资源释放 28 第十一章 附录 29 11.1 HTML/JSP格式建议 29 11.1.1 文件头 29 11.1.2 缩进 29 概述 编写目的 开发规范制定的目的是为了保证在系统设计、编码、测试、维护的过程中项目组人员遵循一套标准软件开发团队的效率 IBM官方网站：/developerWorks 关于代码规范标准可参阅： Java Programming Style Guide /style.jsp AmbySoft Inc. Coding Standards for Java v17.01d /javaCodingStandards.html Code Conventions for the JavaTM Programming Language /docs/codeconv/html/CodeConvTOC.doc.html 《Effivtive Java》 《Thinking in Java》 代码格式与风格 基本原则 代码格式与风格的基本原则是：便于开发，易于交流，前后一致，符合本规范求，形成全公司统一风格。 缩进 子功能块当在其父功能块后缩进。 当功能块过多而导致缩进过深时当将子功能块提取出来做为子函数。 代码中以TAB（4个字符）缩进，在编辑器中请将TAB设置为以空格替代，否则在不同编辑器 或设置下会导致TAB长度不等而影响整个程序代码的格式。例如： Table1．缩进示例 public void methodName() { if(some condition) { for(…) { //some sentences } //end for } //end if } 长度 为便于阅读和理解，单个函数的有效代码长度当尽量控制在100行以内（不包括注释行），当一个功能模块过大时往往造成阅读困难，因此当使用子函数等将相应功能抽取出来，这也有利于提高代码的重用度。 单个类也不宜过大，当出现此类情况时当将相应功能的代码重构到其他类中，通过组合等方式来调用，建议单个类的长度包括注释行不超过1500行。 尽量避免使用大类和长方法。 行宽 页宽应该设置为80字符。一般不要超过这个宽度, 这会导致在某些机器中无法以一屏来完整显示, 但这一设置也可以灵活