(java项目团队开发规范.docVIP

项目团队开发规范 文件状态： [√]草稿 [ ]正式发布 [ ]正在修改 文件标识： 当前版本： V.1.0 作 者： 傅家龙 完成日期： 2015年5月22日 修订历史记录 日期 版本 说明 作者 目 录 1 引言 4 1.1 编写目的 4 1.2 预期读者 4 1.3 编写背景 4 2 概述 5 2.1 目标 5 2.2 修改及完善 5 3 详细规范 5 3.1 使用的工具 5 3.2 框架设计 5 3.3 包目录 6 3.4 编码规范 7 3.4.1 目的 7 3.4.2 依据 7 3.4.3 具体规范 8 3.4.3.1 编码风格 8 3.4.3.1.1 缩进 8 3.4.3.1.2 空格 8 3.4.3.1.3 对齐 9 3.4.3.1.4 空行 9 3.4.3.1.5 代码长度 10 3.4.3.1.6 行数 10 3.4.3.1.7 注释 10 3.4.3.2 代码效率 13 3.4.3.2.1 综述 13 3.4.3.2.2 具体实现 13 3.4.3.3 异常处理 13 3.4.3.3.1 处理CHECK 异常与UNCHECK异常 13 3.4.3.4 程序调试 13 3.4.4 日常交流 14 3.4.4.1 互相促进 14  引言 编写目的 本文档作为项目团队开发规范的说明书，描述了项目开发过程中的使用的工具，框架，代码编写规范及注意问题，作为项目团队建设，开发及测试工作的依据。 预期读者 本文档的预期读者包括以下几类： 项目组长 项目组全体成员 编写背景 根据公司现有的开发状况，决定组件稳定的项目开发团队，制定全体团队成员共识的开发规范，有助于提高项目开发的效率、项目团队整体水平的提升。 概述 目标 建设一个团结、规范、进取的团队，规范项目的开发工作，提高项目组成员团队合作意识，更好的提高团队及个人的能力。 修改及完善 本规范仅是初步设计，会在具体的项目开发过程中不断的修改及完善。 详细规范 使用的工具 JDK： IDE： Version Control：SubVersion1.5 VSS Bug Manager： JSP Container： 框架设计 J2EE： ORM： MVC： AJAX： JAVASRIPT： 包目录 说明： Src：实现类源文件夹 common 存放实际业务系统中有共性的处理类 Constant 存放业务系统的常量接口 Dao 存放具体实体的数据库访问对象类 Exception 存放异常处理类 Model 存放实体（普通Java Bean，Hibernate映射实体） Service 存放业务处理类(调用Dao，及util里面的方法) Web MVC前端框架处理类 Servlet ：普通servlet类 Framework.struts2.action ： struts2.0框架控制类 Test：单元测试类源文件夹 Dao 测试业务实现类DAO层 Service 测试业务实现类service层 Util 测试业务实现工具类 命名规则： 原则： 尽量使用英文单词来作为类的命名，勿以汉语拼音词的首字母来命名，如不能以英文命名，则须以汉语拼音的全拼来命名。 Dao： 以访问的表为命名依据，如果是对单个的表或实体操作，则以单个表的表名去除下划线首字母大写或实体名称，加“DAO”做DAO类的名称,如果是多个表关联或多个实体关联则以主表表名去除下划线或主实体名称，加”DAO”作为类名。 Service： 以相应的业务名称加“Service”来作为类名。 Action： 以相应业务系统中页面操作名称加”Action”来命名。 编码规范 目的 制定统一的编码规范，使项目组成员养成良好的编程习惯，提高代码的效率及可读性，使代码达到很好的整合控制。 依据 Sun公司基本的JAVA规范，及具体实践中的经验。 具体规范 编码风格 缩进 建议以4个空格为单位。建议在MyEclipse下设置 预处理语句、全局数据、标题、附加说明、函数说明、标号等均顶格书写 语句块的{、}配对对齐，并与其前一行对齐，语句块类的语句缩进建议每个{、}单独占一行，便于匹对。 空格 原则上变量、类、常量数据和函