文档介绍：JSP产品
开发规范

文档控制/Document Control
修改记录
日期
作者
版本
备注
审阅人
日期
审阅人
版本
备注
分发
日期
分发人
分发对象
备注

目录

第一章、概述 4
、目的 4
、范围 4
、文档约定 4
、相关概念及词汇列表 4
、相关角色 5
第二章、协作规范 6
、参与协作开发 6
、相关规范 6
第三章、设计规范 8
、JAVA存放位置 8
、页面存放位置 9
、配置文件存放位置 9
、业务代码位置 10
、数据库设计 10
、Model规范 11
、Design配置规范 11
、JAVA类规范 12
、JSP界面规范 13
、properties资源文件规范 14
第四章、代码规范 16
、命名规范 16
、风格规范 21

第一章、概述
、目的
对于代码,首要要求是它必须正确,能够按照程序员的真实思想去运行;第二个的要求是代码必须清晰易懂,使别的程序员能够容易理解代码所进行的实际工作。
通过建立开发规范,形成开发小组编码约定,提高程序的可靠性、可读性、可修改性、可维护性、可继承性和一致性,可以保证程序代码的质量,继承软件开发成果,充分利用资源,使开发人员之间的工作成果可以共享。
、范围
1、项目组成员;
2、技术开发人员;
3、其他经公司认可的必要知情的人员。
、文档约定
本文档采用MS Word2003软件编写,采用统一风格排版,正文风格为:五号中文宋体、五号英文Arial字体、;
针对需要重点注意的段落,采用红色描色。
一般来说,各章内容相对独立,构成全文的有效组成部分。
、相关概念及词汇列表
【同步代码】
在进行开发的过程中将本地的代码和SVN服务器的代码进行同步,在eclipse中的操作叫Synchronize whit Repository。
【合并代码】
在同步的过程中,发现本地的代码和服务器上的代码都有所改变,这个时候会产生冲突,就需要合并代码。
【签入】
在进行开发的过程中将代码放入SVN服务器的操作叫签入(check-in),在eclipse中的操作叫提交。
【签出】
在进行开发的过程中将代码从SVN服务器下载下来的操作叫签出(check-out),在eclipse中的操作叫更新。
、相关角色
【开发人员】
根据开发规范,进行日常开发工作。
【SVN管理员】
管理SVN服务器,包括开通帐号、停止帐号、处理SVN遇到的问题。

第二章、协作规范
开发人员编写程序的过程中,每个程序都会有很多不同的版本,这就需要开发人员很好的管理代码,在需要的时间可以取出需要的版本,并且每个版本都需要一个完成的说明和标记。我们公司采用Sub Version(简称SVN,主要用于定制项目管理)和Rational team concert(简称RTC,主要用于产品管理)做为版本管理工具,在多个开发人员开发同一段代码的过程中,版本的管理和协作规范显得尤为重要。
、参与协作开发
如何参与协作开发,具体参考以下文档:
SVN:《》
RTC:《》
、相关规范
开发环境一律使用公司标准开发环境,如使用自己的开发环境,遇到问题则自己行解决;
每个开发人员都有自己的帐号和密码,禁止使用其他开发人员的帐号和密码,可以保证每个版本都能找到相应的开发人员,如需开通新帐号密码,请告知SCM管理员;
遇到SCM服务器问题,应及时寻找SCM管理员帮助解决,避免自己去尝试解决导致服务器崩溃;
发现冲突必须经过手动合并后才能上传到SCM服务器上,不能将其他开发人员的代码直接覆盖,导致代码丢失;
上传的代码必须保证是能运行的代码,不能将未经过测试的代码就上传SCM服务器上,导致其他发开人员项目启动不了;
每天下班前将当天开发的已完成的代码提交到服务器上;
每天早上来到公司应该同步SCM服务器,将最新的代码更新到本地,可以避免服务器崩溃后找不到最新的代码。
注:开发人员必须遵守以上规范,如发现未遵守以上规范,导致代码丢失或者影响其他开发人员正常工作的行为,会给予相应的处罚

第三章、设计规范
开发人员在编程过程代码目录结构、业务逻辑在什么地方、配置文件存放位置等都需要规范,以便其他开发人员快速查找文件,减少开发过程中的沟通,减少维护成本。
、JAVA存放位置
src是存放JAVA代码的目录,.landray.