开发文档-编程规范.docVIP

________________________________________________ 编码规范 ________________________________________________  修订历史记录 文档标识 LENOVO-JAVA-1_0.doc 页数 文档名称 JAVA编码规范 序号 修改描述 版本号 日期 作者 1 创建文档 1.0 2010/04/01 胡少华  1. 应用范围 3 2. 设计类和方法 3 2.1 创建具有很强内聚力的类 3 2.2 创建松散连接和高度专用的方法 3 2.3 编程原则 4 3. 命名约定 5 3.1 包、类及方法命名 5 3.2 其它 6 4. 使用常量 6 4.1 使用常量 6 5. 变量 7 5.1 定义有焦点的变量 7 5.2 只对常用变量名和长变量名进行缩写 7 5.3 使用统一的量词 7 5.4 使用肯定形式的布尔变量 7 5.5 为每个变量选择最佳的数据类型 7 5.6 尽量缩小变量的作用域 8 6. 代码的格式化 8 6.1 对代码进行格式化时，要达到的目的 8 6.2 编程原则 8 7. 代码的注释 9 7.1 使用代码注释的目的 9 7.2 编程原则 9 7.3 注释哪些部分 11 7.4 示例 11 7.4.1 块注释： 11 7.4.2 行注释： 12 7.4.3 尾随注释： 12 7.4.4 行尾注释： 12 7.4.5 文档注释： 12 8. 表达式和语句 12 8.1 每行应该只有一条语句。 12 8.2 if-else,if-elseif语句，任何情况下，都应该有“{”，“}”，格式如下： 12 8.3 for语句格式如下： 13 8.4 while语句格式如下： 13 8.5 do-while语句格式如下： 13 8.6 switch语句，每个switch里都应包含default子语句,格式如下： 13 8.7 try-catch语句格式如下： 13 9. 错误处理和异常事件 14 10. 封装、事务 14 11. 可移植性 14  应用范围 本规范应用于采用J2EE规范的项目中，所有项目中的JAVA代码（含JSP，SERVLET，JAVABEAN，EJB）均应遵守这个规范。 设计类和方法 建具有很强内聚力的类 方法的重要性往往比类的重要性更容易理解，方法是指执行一个统一函数的一段代码。类常被错误的视为是一个仅仅用于存放方法的容器。有些开发人员甚至把这种思路作了进一步的发挥，将他们的所有方法放入单个类之中。 之所以不能正确的认识类的功能，原因之一是类的实现实际上并不影响程序的执行。当一个工程被编译时，如果所有方法都放在单个类中或者放在几十个类中，这没有任何关系。虽然类的数量对代码的执行并无太大的影响，但是当创建便于调试和维护的代码时，类的数量有时会带来很大的影响。 类应该用来将相关的方法组织在一起。当类包含一组紧密关联的方法时，该类可以说具有强大的内聚力。当类包含许多互不相关的方法时，该类便具有较弱的内聚力。应该努力创建内聚力比较强的类。大多数工程都包含许多并不十分适合与其他方法组合在一起的方法。在这种情况下，可以为这些不合群的方法创建一个综合性收容类。创建类时，应知道“模块化”这个术语的含义是什么。类的基本目的是创建相当独立的程序单元。 创建松散连接和高度专用的方法 使所有方法都执行专门的任务 每个方法都应执行一项特定的任务，它应出色的完成这项任务。应避免创建执行许多不同任务的方法。 创建专用方法有许多好处。首先调试将变得更加容易。尽量使方法成为自成一体的独立方法 当一个方法依赖于其他方法的调用时，称为与其他方法紧密连接的方法。紧密连接的方法会使调试和修改变得比较困难，因为它牵涉到更多的因素。松散连接的方法优于紧密连接的方法，但你不可能使每个方法都成为独立的方法。 若要使方法具备较强的独立性，方法之一是尽量减少变量。 创建方法时，设法将每个方法视为一个黑箱，其他例程不应要求了解该方法的内部工作情况，该方法也不应要求了解它外面的工程情况。这就是为什么你的方法应依靠参数而不应依靠全局变量的原因。 创建专用方法时，请考虑下列指导原则： 将复杂进程放入专用方法。如果应用程序使用复杂的数学公式，请考虑将每个公式放入它自己的方法中。这样使用这些公式的其他方法就不包含用于该公式的实际代码。这样也可以更容易发现与公式相关的问题。 将数据输入