Java开发规范及编程的风格

Java 开发规范 Java 开发规范 Java Development Specification 版本 2.0 版本 2.0 当前版本 2.0alpha 制定日期 2004-07-18 文档编号 Java_Dev_Spec 文档作者 韩卿(l_walker) 电子邮件 walkerskyinn.org Skyinn Group(http:/www.skyinn.org)Skyinn Group(http:/www.skyinn.org) 文档名称 Java开发规范 版本 2.0alpha 文档编号 Java_Dev_Spec 日期 2004-7-18 修订历史记录 修订历史记录 日期 日期 版本 版本 说明 说明 作者 作者 2002-9-7 1.0 创建文件 韩卿 2002-9-8 1.0 修改、增加 韩卿 2002-9-9 1.0 完成 韩卿 2003-1-19 1.0 更新 韩卿 2003-05-28 1.1 修改并完成 韩卿 2004-7-3 2.0 修改版式 韩卿 2004-7-11 20 更新文档 韩卿 2004-7-18 2.0 alpha 更新并发布 韩卿 共享 Copyright(C) Skyinn Group, 2002-2004 http:/www.skyinn.org 第 2 页/共 2 页 文档名称 Java开发规范 版本 2.0alpha 文档编号 Java_Dev_Spec 日期 2004-7-18 目录 目录 第第 1 章章 绪论绪论.5 1.1 目的目的.5 1.2 范围范围.5 1.3 版权声明版权声明.5 1.4 参考资料参考资料.5 1.5 概述概述.5 第第 2 章章 代码组织与风格代码组织与风格.7 2.1 基本原则基本原则.7 2.2 缩进缩进.7 2.3 长度长度.7 2.4 行宽行宽.7 2.5 间隔间隔.7 2.6 对齐对齐.7 2.7 括号括号.8 第第 3 章章 注释注释.9 3.1 基本原则基本原则.9 3.2 JAVADOC.9 3.3 文件与包注释文件与包注释.9 3.4 类、接口注释类、接口注释.10 3.5 方法注释方法注释.10 3.6 其他注释其他注释.11 3.7 注释参考表注释参考表.11 第第 4 章章 命名命名.13 4.1 基本原则基本原则.13 4.2 文件、包文件、包.13 4.3 类、接口类、接口.13 4.4 字段字段.14 4.5 方法方法.14 4.6 异常异常.15 4.7 命名约定表命名约定表.15 第第 5 章章 声明声明.17 5.1 基本原则基本原则.17 5.2 包包.17 5.3 类、接口类、接口.17 5.4 方法方法.17 5.5 字段字段.18 5.6 示例示例.18 第第 6 章章 类与接口类与接口.20 6.1 基本原则基本原则.20 6.2 抽象类与接口抽象类与接口.20 6.3 继承与组合继承与组合.20 共享 Copyright(C) Skyinn Group, 2002-2004 http:/www.skyinn.org 第 3 页/共 3 页 文档名称 Java开发规范 版本 2.0alpha 文档编号 Java_Dev_Spec 日期 2004-7-18 6.4 构造函数和静态工厂方法构造函数和静态工厂方法 .20 6.5 TOSTRING(),EQUALS(),HASHCODE()20 6.6 SINGLETON CLASS22 第第 7 章章 方法方法.23 7.1 基本原则基本原则.23 7.2 参数和返回值参数和返回值.23 第第 8 章章 表达式与语句表达式与语句.24 8.1 基本原则基本原则.24 8.2 控制语句控制语句.24 8.3 循环语句循环语句.25 第第 9 章章 错误与异常错误与异常.26 9.1 基本原则基本原则.26 9.2 已检查异常与运行时异常已检查异常与运行时异常 .26 9.3 异常的捕捉与处理异常的捕捉与处理.26 第第 10 章章 测试与测试与BUG跟踪跟踪.27 10.1 基本原则基本原则.27 10.2 测试驱动开发测试驱动开发.27 10.3 JUNIT单元测试单元测试.27 10.4 自动测试与持续集成自动测试与持续集成 .27 10.5 BUG跟踪和缺陷处理跟踪和缺陷处理27 第第 11 章章 性能与安全性能与安全.28 11.1 基本原则基本原则.28 11.2 STRING与与STRINGBUGFFER28 11.3 集合集合.28 11.4 对象对象.28 11.5 同步同步.28 11.6 FINAL.28 11.7 垃圾收集和资源释放垃圾收集和资源释放 .29 第第 12 章章 其他其他.30 12.1 目录结构目录结构.30 12.2 CVS注释与标记注释与标记.31 12.331 第第 13 章章 附录附录.32 13.1 CVS标识符标识符.32 13.2 注释模板注释模板.32 13.3 常用缩写简表常用缩写简表.33 13.4 版权声明模板版权声明模板.33 13.5 示例代码示例代码.34 共享 Copyright(C) Skyinn Group, 2002-2004 http:/www.skyinn.org 第 4 页/共 4 页 文档名称 Java开发规范 版本 2.0alpha 文档编号 Java_Dev_Spec 日期 2004-7-18 Java 开发规范 Java 开发规范 第1章 绪论 第1章 绪论 1.1 目的 1.1 目的 本规范的目的是使本组织能以标准的、规范的方式设计和编码。通过建立编码规范，以使每 个开发人员养成良好的编码风格和习惯；并以此形成开发小组编码约定，提高程序的可靠性、可 读性、可修改性、可维护性和一致性等，增进团队间的交流，并保证软件产品的质量。 1.2 范围 1.2 范围 本规范适用于“Skyinn Group”及其下所有软件项目、产品等的设计、开发以及维护、升级 等。 本规范使用于“Skyinn Group”的所有软件开发人员，在整个软件开发过程中必须遵循此规 范。 1.3 版权声明 1.3 版权声明 本文档为共享文档，不限转载，但请保持本文档的完整性。 您可以修改本文档以符合您或组织、公司等之实际，但请在文档中保持对本文档的引用和说 明。 未经本人授权，任何个人、组织或单位不得将本文档用于书面发表、转载、摘录等，亦不得 用于其他商业行为。 本人及本组织不承担任何因使用、参考本文档等而导致的任何可能责任或连带责任。 1.4 参考资料 1.4 参考资料 Java 编程指南见 RUP（Rational Unified Process）中文版。 Java 技术手册(Java in a Nutshell) Sun Java 语言编码规范(Java Code Conventions) Effictive Java Java Pitfalls Java Rules 1.5 概述 1.5 概述 对于代码，首要要求是它必须正确，能够按照设计预定功能去运行；第二是要求代码必须清 晰易懂，使自己和其他的程序员能够很容易地理解代码所执行的功能等。然而，在实际开发中， 每个程序员所写的代码却经常自成一套，很少统一，导致理解困难，影响团队的开发效率及系统 的质量等。因此，一份完整并被严格执行的开发规范是非常必须的，特别是对软件公司的开发团 队而言。此规范参考自业界标准编程规范并结合本人多年编程经验、习惯等而制定，在本人工作 过的公司中都曾参考本文档而形成内部开发规范并执行。现在将本文档共享之，希望能对各位有 所帮助，并做引玉之砖，希望各位朋友将自己的经验等增补进去，对我们所热爱的软件业有所裨 益。 最根本的原则： 最根本的原则： 代码虽然是给机器运行的，但却是给人读的！ 运用常识。当找不到任何规则或指导方针，当规则明显不能适用，当所有的方法都失效的时 共享 Copyright(C) Skyinn Group, 2002-2004 http:/www.skyinn.org 第 5 页/共 5 页 文档名称 Java开发规范 版本 2.0alpha 文档编号 Java_Dev_Spec 日期 2004-7-18 侯： 运用常识并核实这些基本原则。这条规则比其它所有规则都重要。常识是必不可少。 当出现该情况时，应当及时收集并提交，以便对本规范进行修改。 您可以在以下地址中找到本文档的最新版本： http:/www.skyinn.org/wiki/Wiki.jsp?page=JavaDevSpec 本文档尚未完善，我将不断更新之，如果您有任何问题、建议或意见等请联系我： walkerskyinn.org 共享 Copyright(C) Skyinn Group, 2002-2004 http:/www.skyinn.org 第 6 页/共 6 页 文档名称 Java开发规范 版本 2.0alpha 文档编号 Java_Dev_Spec 日期 2004-7-18 第2章 代码组织与风格 第2章 代码组织与风格 2.1 基本原则 2.1 基本原则 代码的组织和风格的基本原则是：便于自己的开发，易于与他人的交流。 因个人习惯和编辑器等可以设置和形成自己的风格，但必须前后一致，并符合本规范的基本 要求和原则。 本章所涉及到的内容一般都可在 Java 集成编辑环境中进行相应设置，也可由 Ant 等调用 checkstyle 等来进行自动规整。 2.2 缩进 2.2 缩进 子功能块当在其父功能块后缩进。 当功能块过多而导致缩进过深时当将子功能块提取出来做为子函数。 代码中以 TAB（4 个字符）缩进，在编辑器中请将 TAB 设置为以空格替代，否则在不同编辑器 或设置下会导致 TAB 长度不等而影响整个程序代码的格式。例如： Table1缩进示例 public void methodName() if(some condition) for() /some sentences /end for /end if 2.3 长度 2.3 长度 为便于阅读和理解，单个函数的有效代码长度当尽量控制在 100 行以内（不包括注释行）， 当一个功能模块过大时往往造成阅读困难，因此当使用子函数等将相应功能抽取出来，这也有利 于提高代码的重用度。 单个类也不宜过大，当出现此类情况时当将相应功能的代码重构到其他类中，通过组合等方 式来调用，建议单个类的长度包括注释行不超过 1500 行。 尽量避免使用大类和长方法。 2.4 行宽 2.4 行宽 页宽应该设置为 80 字符。一般不要超过这个宽度, 这会导致在某些机器中无法以一屏来完整 显示, 但这一设置也可以灵活调整。在任何情况下, 超长的语句应该在一个逗号后或一个操作符 前折行。一条语句折行后, 应该比原来的语句再缩进一个 TAB 或 4 个空格，以便于阅读。 2.5 间隔 2.5 间隔 类、方法及功能块间等应以空行相隔，以增加可读性，但不得有无规则的大片空行。 操作符两端应当各空一个字符以增加可读性。 相应独立的功能模块之间可使用注释行间隔，并标明相应内容，具体参看附录的代码示例 2.6 对齐 2.6 对齐 关系密切的行应对齐，对齐包括类型、修饰、名称、参数等各部分对齐。 连续赋值时当对齐操作符。 共享 Copyright(C) Skyinn Group, 2002-2004 http:/www.skyinn.org 第 7 页/共 7 页 文档名称 Java开发规范 版本 2.0alpha 文档编号 Java_Dev_Spec 日期 2004-7-18 当方法参数过多时当在每个参数后（逗号后）换行并对齐。 当控制或循环中的条件比较长时当换行（操作符前）、对齐并注释各条件。 变量定义最好通过添加空格形成对齐，同一类型的变量应放在一起。如下例所示： Table2对齐示例 /变量对齐-