软件编程规范(JAVA)精要.doc

JAVA（B/S）开发规范 文档编号 编制 审核 批准 密级 密 版本 V1.0 发布日期 更改记录 序 号 版本 更改处·更改内容 更改人/日期 审核人/日期 批准人/日期 初版建立 目录 1 绪论 7 1.1 目的 7 1.2 范围 7 1.3 版权声明 7 1.4 参考资料 7 1.5 概述 7 2 Java编码规范 8 2.1 代码组织与风格 8 2.1.1 基本原则 8 2.1.2 缩进 8 2.1.3 长度 9 2.1.4 行宽 9 2.1.5 间隔 9 2.1.6 对齐 10 2.1.7 括号 11 2.2 注释 11 2.2.1 基本原则 11 2.2.2 JavaDoc 11 2.2.3 内容要求 12 2.2.4 具体要求 13 2.3 命名 17 2.3.1 基本原则 17 2.3.2 总体要求 17 2.3.3 具体要求 19 2.4 声明 22 2.4.1 基本原则 22 2.4.2 包 22 2.4.3 类、接口 22 2.4.4 方法 23 2.4.5 字段 24 2.4.6 示例 24 2.5 类与接口 27 2.5.1 基本原则 27 2.5.2 抽象类与接口 27 2.5.3 继承与组合 27 2.5.4 构造函数和静态工厂方法 28 2.5.5 toString(),equals()及hashCode()... 28 2.5.6 Singleton Class 30 2.6 方法 30 2.6.1 基本原则 30 2.6.2 参数和返回值 31 2.7 表达式与语句 31 2.7.1 基本原则 31 2.7.2 控制语句 32 2.7.3 循环语句 34 2.8 错误与异常 34 2.8.1 基本原则 34 2.8.2 已检查异常与运行时异常 35 2.8.3 异常的捕捉与处理 35 2.9 9性能与安全 36 2.9.1 基本原则 36 2.9.2 String与StringBugffer 36 2.9.3 集合 37 2.9.4 对象 37 2.9.5 同步 37 2.9.6 final 38 2.9.7 垃圾收集和资源释放 38 2.10 附录 39 2.10.1 常用缩写简表 39 2.10.2 Netbeans下配置注释模板 39 2.10.3 eclipse下配置注释模板 39 3 Flex编码规范 39 3.1 缩写： 39 3.2 文件名： 40 3.3 类名 40 3.4 包： 40 3.5 命名空间： 40 3.6 接口名称： 40 3.7 常量 41 3.8 变量名 41 3.9 方法命名： 41 3.10 事件处理器命名 42 3.11 参数命名 42 3.12 属性名命名 42 3.13 存储变量命名： 43 3.14 控件ID 43 3.15 声明： 43 3.16 行、换行、缩进、空格 43 3.17 注释 44 3.18 表达式相关： 45 3.19 强制类型转换 45 3.20 比较 45 3.21 ++和–操作 45 3.22 三元操作符 46 3.23 New 46 3.24 Include 46 3.25 use namespace 46 3.26 if 47 3.27 保留字、关键字 47 3.28 其他注意事项 48 4 JAVAEE开发规范 49 4.1 总体目录结构 50 4.2 页面开发规范 53 4.2.1 界面风格 53 4.2.2 目录划分 53 4.2.3 文件命名 53 4.2.4 字符集 53 4.2.5 标签库的使用 53 4.2.6 jsp/html描述注释 53 4.2.7 控制脚本 54 4.3 EJB开发规范 54 4.4 RestfullWebservice开发规范 54 4.5 WebBuilder开发规范 54 4.6 Struts2开发规范 54 绪论 目的 本规范的目的是使开发人员能以标准的、规范的方式设计和编码。通过建立编码规范，以使每个开发人员养成良好的编码风格和习惯；并以此形成开发规范，提高程序的可靠性、可读性、可修改性、可维护性和一致性等，增进团队间的交流，并保证软件产品的质量。 范围 本规范适用于公司所有软件项目、产品的设计、开发以及维护、升级等（采用JAVA语言编写），是软件开发及维护人员在整个软件生命周期中必须遵循此规范。 版权声明 本文档为公司内部技术文档，未经授权任何项目组或个人不得将本文档用于书面发表、转载、摘录等，亦不得用于其他商业行为。 参考资料 《Java 编程指南》见RUP（Rational Unified