项目开发规范.docx

《项目开发规范.docx》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、项目结构及开发规范1.项目包结构src—com—zufe——common——dao——generic(泛型DAO接口及实现)——freemarker(freemarker数据模型封装类)——hibernate——dao——pojo(持久化对象)——service——impl（业务逻辑实现）——servlet——struts——action——utils(工具类)—applicationContext-action.xml(action配置)—applicationContext-dao.xml(dao配置)—applic

2、ationContext-hibernate.xml(hibernate配置)—applicationContext-service.xml(service配置)—config.properties(项目全局配置)—echache.xml(hibernate二级缓存配置文件)—log4j.properties(log4j日志配置文件)—proxool.xml(proxool数据连接池配置文件)—struts.xml(struts2中action配置文件)test(测试包，所有测试内容可在此包下进行)database(存放

3、数据库文件)document(存放项目相关文档,所有文档都可在此目录下查找)WebRoot—admin(后台文件)—common(公共文件夹)—html(存放freemarker生成的静态页面)—query-easyui-1.2.4——ux(可在文件夹下存放jquery扩展插件)—kindeditor-4.0—templates(存放freemarker模板文件)—upload(存放上传文件)1.命名规范1.1.action命名：以大写字母开头，如果有多个单词，每个单词头字母大写，加上Action，如UserCrudAc

4、tion.java。如果前台与后台代码为两人分开写，负责前台的请在名称前面加字母Q,如QUserCrudAction.java。1.2.dao命名：接口：以大写字母"I"开头，如果有多个单词，每个单词头字母大写，后面加上Dao，如：IUserDao.java实现：将实现的接口名称的首字母"I"去掉，如：UserDao.java1.3.service命名：接口：以大写字母开头，如果有多个单词，每个单词头字母大写，后面加上Service，如：UserService.java实现：将实现的接口名称的后面添加Impl，如：Use

5、rServiceImpl.java1.4.实体Bean命名：数据库名去掉前面的T，后面的首字母大写例如：数据表名是T_AA_BB_CC_DD则其对应的实体应该是：AaBbCcDd.java1.5.自定义类命名：以大写字母开头，如果有多个单词，每个单词头字母大写，如CheckPwd.java1.1.类变量命名：变量名首字母必须小写，如果该变量名有多个单词组成，后面的单词首字母大写，单词与单词之间不要使用"_"做连接，变量名访问控制必须为私有，可以对其增加setter与getter方法。例如：privateintuserNa

6、me;publicintgetUserName(){returnuserName;}publicvoidsetUserName(intuserName){this.userName=userName;}1.2.常量命名：　　所有字母大写，如果有多个单词组成，单词与单词之间以”_“隔开。而且该变量必须是公共、静态、final类型　　例如：publicstaticfinalStringUSER_NAME=“username”;1.3.方法命名　　首字母必须小写，如果该变量名有多个单词组成，后面的单词首字母大写，单词与单词之间

7、不要使用"_"做连接。单词不要使用名词。例如：publicintcheckLogin（Stringname,Stringpwd）{}1.1.Js代码中变量、函数命名（特别easyUI）由于后台所有代码都在一张页面，命名要特别注意，避免和其它人定义的变量冲突。例：定义窗口时，不能简单的定义win,windows之类，要根据所属模块和实现的功能定义，如UserAddWin。2.注释要求请参照javadoc注释规范。2.1.类的注释：2.1.1.作用：注释整个类，简单概述该类作用。2.1.2.书写规范：类的注释必须写在该类的声

8、明语法之前。在注释中要描述该类的基本作用，作者，日期，版本等。2.1.3.格式：/***类功能描述：（大致描述类的功能）*@author：编写者名称**@version：类文件的版本号从1.0开始（自己确定版本号的增改情况），修改情况（修改时间、作者、改动情况）**@see包名.参考类名（列出父类，引入类，每个类占一