强智科技JAVA编码规范.docVIP

强智科技开发规范 Java编码规范 文档类别 编码规范 文档编号 1.0 版 本 号 名称 Java编码规范 湖南强智科技发展有限公司 2007年8月 本文档修改记录 日 期 内 容 摘 要 编 制/修 改 审 核 2007-08-03 整理、合并形成文档 谢平 2009-07-22 修订 聂磊 目 录 1 前言 5 1.1 简介 5 1.2 目的 5 1 总体开发规范 6 1.3 源代码总体结构 6 1.4 页面目录结构 8 1.5 业务逻辑建模 9 1) 各层的开发规范 9 2 Java编码通用规则 12 2.1 文件命名 13 2.1.1 文件后缀 13 2.1.2 通用的文件名 13 2.2 命名规范 13 2.2.1 Package 的命名 14 2.2.2 Class 的命名 14 2.2.3 Class 变量的命名 14 2.2.4 Static Final 变量的命名 14 2.2.5 参数的命名 14 2.2.6 数组的命名 14 2.2.7 方法的参数 14 2.3 Java文件样式 14 2.3.1 版权信息 15 2.3.2 Package/Imports 15 2.3.3 Class 15 2.3.4 Class Fields 15 2.3.5 存取方法 16 2.3.6 构造函数 16 2.3.7 类方法 16 2.3.8 toString 方法 17 2.3.9 main 方法 17 2.4 代码编写格式 17 2.4.1 代码样式 17 2.4.2 文档化 17 2.4.3 缩进 17 2.4.4 页宽 17 2.4.5 {} 对 18 2.4.6 括号 18 2.5 程序编写规范 18 2.5.1 exit() 18 2.5.2 垃圾收集 18 2.5.3 final 类 18 2.5.4 访问类的成员变量 19 2.5.5 异常 19 2.6 编程技巧和性能优化 19 2.6.1 byte 数组转换到 characters 19 2.6.2 初始化 19 2.6.3 枚举类型 19 2.6.4 调试 19 2.6.5 性能 20 2.6.6 不必要的对象构造 20 2.6.7 使用 StringBuffer 对象 20 2.6.8 避免太多的使用 synchronized 关键字 20 2.6.9 换行 20 2.6.10 PrintStream 20 2.6.11 关于session 20 3 项目编码规则 22 3.1 命名规则 22 3.1.1 通用命名规则 22 3.2 文档和格式规则 23 3.2.1 通用规则 23 3.2.2 代码的表现风格： 24 3.2.3 随后的文件头中包含 24 3.2.4 类和接口的段 24 3.2.5 类和接口的注释 25 3.2.6 成员方法的注释 25 3.3 编码风格例子 25 附录1： 编码注意事项及常见问题 30 附录2： 了解Java Doc 33 附录3： 语句和表达式的参照格式 33 附录4： 参考文献 35 前言 简介 本文档给出的规范及规则有助于提高Java程序的编码风格及结构。代码质量的好坏关系到将来代码的维护、性能、可移植性等问题，文中指出了开发人员常犯的影响代码质量的错误，给出的规则供程序员使用以防止类似的错误发生，并减少将来用于程序诊断及优化的时间。 同时，良好的编码习惯有助于标准化程序的结构和编码风格，使源代码对于自己和别人都易读和易懂。在开发周期中越早使用恰当的编码规定，将会最大程度的提高项目的生产率。良好的编码习惯除了代码格式，详细的注释外，还应该包括使用有助于提高程序效率的编码方式。本文档的另一个目的是引导新的程序员建立一个规范、良好的编码习惯。规范的开发有助于提高源码的可读性，可维护性，对于提高项目的整体效率更是不可缺少的（尤其是团队开发）。 本文包括两部分，第一部分为Java编码通用规则，第二部分为针对本项目的建议规则及定义。附录中为总结一些编程经验后提出的注意事项。 目的 该规范的目的是让项目中所有的文档看起来像一个人写的，增加可读性，减少项目组中因为换人带来的损失。（这些规范并不是一定要绝对遵守，但是一定要让程序有良好的可读性）让程序有良好的可读性 源代码总体结构 目录说明： comm.包：公共开发框架包，所有公共开发框架均存放此处，注意该包属于公共开发框架类，不允许在任何应用系统中修改该包里面的任何代码； framework包：公共框架应用程序包，所有对于公共框架中应用操作均放此处； generic包：通用持久化接口包，持久化操作均放此处； servlet包：所有通用的servlet均放此处； tag包：所有公共标记解析类均存放此处； ut