java项目团队开发规范.doc

《java项目团队开发规范.doc》由会员上传分享，免费在线阅读，更多相关内容在应用文档-天天文库。

1、项目团队开发规范文件状态：[√]草稿[]正式发布[]正在修改文件标识：当前版本：作者：完成日期：修订历史记录日期版本说明作者目录1引言41.1编写目的41.2预期读者41.3编写背景42概述52.1目标52.2修改及完善53详细规范53.1使用的工具53.2框架设计53.3包目录63.4编码规范73.4.1目的73.4.2依据73.4.3具体规范83.4.3.1编码风格83.4.3.1.1缩进83.4.3.1.2空格83.4.3.1.3对齐93.4.3.1.4空行93.4.3.1.5代码长度103.4.

2、3.1.6行数103.4.3.1.7注释103.4.3.2代码效率133.4.3.2.1综述133.4.3.2.2具体实现133.4.3.3异常处理133.4.3.3.1处理CHECK异常与UNCHECK异常133.4.3.4程序调试133.4.4日常交流143.4.4.1互相促进141引言1.1编写目的本文档作为项目团队开发规范的说明书，描述了项目开发过程中的使用的工具，框架，代码编写规范及注意问题，作为项目团队建设，开发及测试工作的依据。1.2预期读者本文档的预期读者包括以下几类：n项目组长n项目组

3、全体成员1.3编写背景根据公司现有的开发状况，决定组件稳定的项目开发团队，制定全体团队成员共识的开发规范，有助于提高项目开发的效率、项目团队整体水平的提升。1概述1.1目标建设一个团结、规范、进取的团队，规范项目的开发工作，提高项目组成员团队合作意识，更好的提高团队及个人的能力。1.2修改及完善本规范仅是初步设计，会在具体的项目开发过程中不断的修改及完善。2详细规范2.1使用的工具JDK：IDE：VersionControl：SubVersion1.5VSSBugManager：JSPContainer

4、：2.2框架设计J2EE：ORM：MVC：AJAX：JAVASRIPT：1.1包目录说明：Src：实现类源文件夹common存放实际业务系统中有共性的处理类Constant存放业务系统的常量接口Dao存放具体实体的数据库访问对象类Exception存放异常处理类Model存放实体（普通JavaBean，Hibernate映射实体）Service存放业务处理类(调用Dao，及util里面的方法)WebMVC前端框架处理类Servlet：普通servlet类Framework.struts2.action：

5、struts2.0框架控制类Test：单元测试类源文件夹Dao测试业务实现类DAO层Service测试业务实现类service层Util测试业务实现工具类命名规则：原则：尽量使用英文单词来作为类的命名，勿以汉语拼音词的首字母来命名，如不能以英文命名，则须以汉语拼音的全拼来命名。Dao：1.以访问的表为命名依据，如果是对单个的表或实体操作，则以单个表的表名去除下划线首字母大写或实体名称，加“DAO”做DAO类的名称,如果是多个表关联或多个实体关联则以主表表名去除下划线或主实体名称，加”DAO”作为类名。S

6、ervice：以相应的业务名称加“Service”来作为类名。Action：以相应业务系统中页面操作名称加”Action”来命名。1.1编码规范1.1.1目的制定统一的编码规范，使项目组成员养成良好的编程习惯，提高代码的效率及可读性，使代码达到很好的整合控制。1.1.2依据Sun公司基本的JAVA规范，及具体实践中的经验。1.1.1具体规范1.1.1.1编码风格1.1.1.1.1缩进1.建议以4个空格为单位。建议在MyEclipse下设置2.预处理语句、全局数据、标题、附加说明、函数说明、标号等均顶格书

7、写3.语句块的"{"、"}"配对对齐，并与其前一行对齐，语句块类的语句缩进建议每个"{"、"}"单独占一行，便于匹对。1.1.1.1.2空格原则上变量、类、常量数据和函数在其类型，修饰名称之间适当空格并据情况对齐。关键字原则上空一格，如：if(... 等。运算符的空格规定如下："::"、"->"、"["、"]"、"++"、"--"、"~"、"!"、"+"、"-"（指正负号）、"&"（引用）等几个运算符两边不加空格（其中单目运算符系指与操作数相连的一边），其它运算符（包括大多数二目运算符和三目运算符"?:

8、"两边均加一空格，在作函数定义时还可据情况多空或不空格来对齐，但在函数实现时可以不用。","运算符只在其后空一格，需对齐时也可不空或多空格。不论是否有括号，对语句行后加的注释应用适当空格与语句隔开并尽可能对齐。个人认为此项可以依照个人习惯决定遵循与否。1.1.1.1.1对齐原则上关系密切的行应对齐，对齐包括类型、修饰、名称、参数等各部分对齐。另每一行的长度不应超过屏幕太多，必要时适当换行，换行时尽可能在","处或运算符处，换行后最好以运算符