Java程序开发规范.docVIP

Java程序 开发规范 文档修订记录 版本 状态 说明 日期 变更人 批准日期 准人 *状态：C――创建，A——增加，M——修改，D——删除 目录 第1章 简介 1 1.1 目的 1 1.2 范围 1 第2章 JavaDoc规范 1 2.1 语法知识 2 2.2 注释举例 2 2.3 JavaDoc的写法 3 2.4 注释范围 4 2.5 Java源文件注释的组成 4 2.6 注意事项 6 2.7 Tag的用法 7 2.7.1 Tag列表 7 2.7.2 常用Tag的用法 7 2.8 包的JavaDoc 8 2.8.1 包注释的写法 8 2.8.2 包注释的内容 9 2.9 Eclipse对JavaDoc的支持 9 2.9.1 Eclipse中注释设置 9 2.9.2 使用Eclipse生成JavaDoc 10 2.9.3 Eclipse Plugin 10 第3章 代码规范 11 3.1 命名规范 11 3.1.1 类的命名 11 3.1.2 接口的命名 12 3.1.3 方法的命名 12 3.1.4 变量的命名 14 3.1.5 包的命名 14 3.2 代码布局 14 3.2.1 Java源文件总体组成 14 3.2.2 缩进 15 3.2.3 空格 15 3.2.4 空白行 15 3.2.5 折行 15 3.2.6 Eclipse中的代码布局 15 3.3 代码尺寸 16 3.4 修饰符使用 16 3.5 异常的使用 16 3.5.1 异常定义 16 3.5.2 异常分类 17 3.5.3 异常设计 17 3.5.4 异常处理 17 3.6 比较、判断与运算 18 3.6.1 比较 18 3.6.2 判断 19 3.6.3 运算 20 3.7 初始化 20 3.7.1 变量的初始化 20 3.7.2 静态block的初始化 20 3.7.3 类的初始化 21 3.8 类设计 21 3.9 字符集的使用 23 3.10 代码规范性验证 24 第4章 参考资料 24 简介 目的 本文档的核心目标包括： 提高代码的正确性、可读性； 提高团队作业的一致性和规范性； 保证产品开发、项目实施的质量； 提高代码、文档的重用性、可维护性、可扩展性。 范围 本文档涉及的规范对象包括： JavaDoc，包括注释的范围，语法等的书写规范； Java源代码，包括类、接口、变量的命名，实例的初始化，源代码的布局等的规范。 JavaDoc规范 JavaDoc是什么 JavaDoc是开发者对其Java程序模块的规格说明书，是程序开发者与使用者之间的契约。通俗的讲，JavaDoc就是Java程序的使用手册，只不过这个手册具备了一个特殊的优点：它是由Java源代码中注释生成的，它始终和源代码保存在一起，代码与注释的更新同步很容易做到。 学习建议 想要详细了解JavaDoc请顺序阅读本章节，并请同时参考Java官方站点关于JavaDoc的写法（URL见参考资料部分）和Java文档生成参考手册官方文档的URL：/j2se/1.5.0/docs/tooldocs/solaris/javadoc.html. 另外建议，常常阅读并模仿JDK和Spring源代码中注释的书写。 快速参与 如需快速生成JavaDoc请参考2.9章节。注意：你真的知道JavaDoc怎么写了么？ 语法知识 整个JavaDoc由Class(Interface)和Package JavaDoc两部分组成，Package的JavaDoc参考2.9章节，Class(Interface)的 JavaDoc由注释块组成。注释块定义如下： /** * {Description} * * {Tags} */ 其中Description是对被注释主体的描述，描述的内容包括：主体的功能，组成，使用条件，参数范围，注意事项，用法示例等[1]。Tags是对被注释主体的输入、输出、异常等要素的定义，如@param，@return，@throws等，对实例变量的注释可以没有Tag。 注释举例 方法的注释举例如下： /** * Determine if the given type is assignable from the given value, * assuming setting by reflection. Considers primitive wrapper classes * as assignable to the corresponding primitive types. * pFor example used in a bean factorys constru