编码规范及要求

Posted on 2007-03-21 20:55 Jaunt 阅读(578) 评论(0)  编辑  收藏 所属分类: 软件工艺

 

1. 类文件的放置要求:
分包的原则是首先按层划分,其次是按模块划分:
① com.yinhe.common      放置本应用的公共类
(例如:GlobalNames.java、DBConnection.java等);
② com.yinhe.util          放置可以被其它web应用重复利用的公共类文件
(例如:编码过滤器EncodeFilter.java、
安全过滤器SavetyFilter.java、
字符过滤器 WordFilter.java、
html语言过滤器HtmlToString.java、
GBK转码类 GBKToString.java等);
③ com.yinhe.login.web     放置在视图层(jsp)中用到的JavaBean值对象
(例如:UserInfVO.java);
④ com.yinhe.login.control    放置控制类和ActionForm
(例如:Struts中的 LoginAction.java、UserForm.java);
⑤ com.yinhe.login.dto      放置在业务逻辑层中用到的JavaBean数据传输对象
(例如:UserInfDTO.java);
⑥ com.yinhe.login.modle    放置业务操作实体类(例如:UserDAO.java);
⑦ com.yinhe.login.pojo     放置JavaBean持久对象(例如:User.java);
⑧ conf                   放置工程配制文件
(例如:ApplicationResources.properties、global.properties)
   conf.spring             放置Spring配制文件(例如:applicationContext.xml等)
   conf.hibernate           放置Hibernate配制文件(例如:hibernate.cfg.xml等)
 
⑨ WEB-INF\conf           放置struts属性配置文件

2. jsp文件的放置要求:
① 所有受保护的(过直接路径不允许访问的页面)放在admins下面,
admins下面的left.jsp放置菜单,top.jsp放置logo,main.jsp为主工作区,
wellcome.jsp为默认的首页(登录成功之后的显示页面);
② 默认的访问首页命名为: index.jsp;

3. 样式文件的放置要求:
① 按照模块划分放置在/css/模块名;公用的样式放在common.css下面;

4. 图片文件的放置要求(非上传文件):
① 按照模块划分放置在/images/模块名;

5. 脚本文件的放置要求:
① 按照模块划分放置在/js/模块名;公用的样式放在common.js下面;

6. 上传文件的放置要求:
① 图片文件放在upload/pic/模块名/文件;
② 非图片文件放在upload/other/文件;

7. 命名要求:
① 所有jsp文件一律小写;
② 所有静态文件的后缀名一律以.htm结尾;

③ 所有类文件都必须严格区分大小写,
接口必须以I开头,实现类以Imp结尾 (例如IUser.java , UserImp.java),
如果是ActionForm必须以Form结尾(UserForm.java);
控制类必须以Action结尾(UserAction.java);
视图类必须以VO结尾(UserVO.java);
所有操作数据库的业务类必须以DAO结尾(UserDao.java);
所有数据传输对象必须以DTO结尾(UserDTO);

④ 所有的包一律小写,分包的原则是首先按层分其次是按模块划分;
 包名的第一及多为com或者org;
⑤ 所有java文件中的变量按照java的要求命名,常量一律全大写;
⑥ 数据库命名:
 表名和java的实体类名对应而且全部大写(例如 USER 表对应 UserDAO.java);
 
⑦ 存储过程的命名:
传入参数以p_开头(例如p_user),局部变量以v_开头(例如 v_intCount),
存储过程的名称以p_开头(例如 p_add),
触发器以t_开头(例如 t_update),视图以v_开头(v_list_user),
所有参数的命名按照前面的原则:
主键以PK_开头,外键以FK_开头,唯一键用UN_开头,
检查约束用CHK_开头,默认值用DEF_开头,
每个表都必须有一个物理ID(自动产生),其命名为ID;
同时还应该有一个逻辑ID,其命名为"表名_"+ID(例如 USER_ID);

 ⑧ 所有的java源文件和数据库的数据对象必须有注释,必须严格按照相应的规则注释,不要为了写注释而写注释,java的注释必须能自动形成JavaDOC文档;

8. 关于提交代码的规定:
 ① 每天上班前必须和CVS同步,每天下班前必须提交自己的代码和文档(代码必须在本地被编译通过);
 ② 当本地文件和CVS产生冲突的时候不要强行覆盖,必须找出冲突的原因,消除冲突后再提交,千万不要把别人的代码给盲目的覆盖了;
 ③ 如果发现jsp文件发生了改变,如果是二进制的比较方式,可能因为增加了换行和回车或者空格而产生冲突,这时可不考虑冲突的问题;

9. 其它事宜:
① 加强沟通,形成高效+创新+强战斗力的团队!
② 服从分配,按时保质保量完成任务~!


 


只有注册用户登录后才能发表评论。


网站导航: