JavaWeb应用开发其他Java编程指南.docVIP

南京润和信息系统有限公司 JAVA编程指南 修订履历 日 期 姓 名 变更履历 2006年04月13日 王永 草案(version:0.1) TOC \o 1-3 \h \z \u 1. 简介 6 2. 程序设计标准 6 2.1. 注释约定 7 2.1.1. Java注释语句类型 7 2.1.2. 源文件的头部注释 8 2.1.3. 快速浏览javadoc 8 2.1.4. 类/接口的头注释 9 3. 方法(成员函数)的标准 10 3.1. 命名方法 10 3.2. 命名存取性的方法 10 3.2.1. 获取性的方法 10 3.2.2. 设置性的方法 11 3.3. 方法的可见性 11 3.4. 注释方法 11 3.4.1. 方法的注释 11 3.4.2. 内部注释 13 3.5. 编写清晰整洁的代码的技巧 14 3.5.1. 给代码加上注释 14 3.5.2. 让代码分段/缩进 14 3.5.3. 使用空白 14 3.5.4. 遵循 30 秒条法则 14 3.5.5. 写短小单独的命令行 15 3.5.6. 说明运行顺序 15 4. 属性标准（属性/字段） 15 4.1. 命名属性 15 4.2. 命名组件（部件） 15 4.3. 命名常量 16 4.4. 命名集合 16 4.5. 属性的可见性 16 4.6. 注释一个属性 17 5. 局部变量标准 17 5.1. 命名局部变量 18 5.1.1. 命名流 18 5.1.2. 命名循环计数器 18 5.1.3. 命名异常对象 18 5.2. 声明并注释局部变量 18 6. 方法的参数标准 19 6.1. 命名参数 19 6.2. 注释参数 19 7. 类、接口、包的标准 20 7.1. 类的标准 20 7.1.1. 命名类 20 7.1.2. 注释类 20 7.1.3. 将公共和保护接口最小化 21 7.2. 接口标准 21 7.2.1. 命名接口 22 7.2.2. 注释接口 22 7.2.3. 接口的使用 22 7.3. 类和接口声明 22 7.4. 包的标准 23 7.4.1. 命名包 23 7.4.2. 注释包 23 7.5. 引入语句 24 8. 错误处理和异常 24 8.1. 必须处理捕获的异常 24 8.2. 在catch语句中使用具体的异常 25 8.3. 充分运用finally 25 8.4. 尽量减小try块的影响范围 25 8.5. 封装异常 26 8.6. 声明为具体的异常 26 9. 缩进排版 26 9.1. 行长度 26 10. Java源文件范例 27 简介 本文提供一整套编写高效可靠的 Java 代码的标准、约定和指南。它们以安全可靠的软件工程原则为基础，使代码易于理解、维护和增强。而且，通过遵循这些程序设计标准，你作为一个 Java 软件开发者的生产效率会有显著提高。经验证明，若从一开始就花时间编写高质量的代码，则在软件开发阶段，对代码的修改要容易很多。最后，遵循一套通用的程序设计标准将带来更大的一致性，使软件开发团队的效率明显提高。 当JAVA项目中没有制定编码规范时，本指南可作为JAVA编码规范使用或做为制定编码规范的依据；当JAVA项目中已经含有编码规范时，本指南可作为以有编码规范的补充。 程序设计标准 Java 的程序设计标准很重要，原因在于它将提高开发团队各成员的代码的一致性。一致性的提高会使代码更易理解，这意味着它更易开发和维护。从而降低了应用程序的总开发成本。 你必须牢记的是：你的 Java 代码在你已离开并开始另一个项目之后，会保留相当长的一端时间。因此开发过程中一个很重要的目标就是要确保在开发成员或开发团队之间的工作可以顺利交接，不必花很大的力气便能理解已编写的代码，以便继续维护和改进以前的工作。如果代码难以理解，很有可能被废弃和重写。 命名约定 使用可以准确说明变量/属性/方法/类的完整的英文描述符。例如，采用类似 firstName，grandTotal 或 CorporateCustomer 这样的名字。虽然象 x1，y1 或 fn 这样的名字很简短，输入起来容易，但是我们难以知道它们代表什么、结果是什么含义，因而使代码难以理解、维护和改进。 采用该领域的术语。如果用户称他们的“客户” (clients) 为“顾客” (customer