关于项目中制定的基本规范

一、关于书写规范

假设学立方域名:www.cubic.cn



包名设计:

cn.cubic.domain;

cn.cubic.service.interfaces;
cn.cubic.service.impl;

cn.cubic.dao.interfaces;
cn.cubic.dao.impl;

cn.cubic.web.filter;
cn.cubic.web.listener;
cn.cubic.web.action;
cn.cubic.web.form;

cn.cubic.exception;
cn.cubic.utils;
cn.cubic.properties;
cn.cubic.junit;



类、接口名的设计:
接口:如:UserService;   (其他一样: UserDao)
类实现: 如: UserServiceImpl;(其他一样: UserDaoImpl)
其他类(驼峰法):
抽象类:以AbstractXxxxx开头
异常类: 以XxxxxxException结尾, 放在cn.cubic.exception;包中

变量名(函数名)用小驼峰法标识。
小驼峰法的意思是:除第一个单词之外,其他单词首字母大写。譬如 int studentCount;


WebRoot的设计:
jsp: 除了index.jsp, 其他统一放在  “jsp”文件夹中
js: 统一放在  “js”文件夹中
css: 统一放在  “css”文件夹中

关于配置文件:

对应的配置文件,放在对应的包里:
如:
hibernate中设计到的对象映射文件(xxxx.hbm.xml): 譬如:User.java位于cn.cubic.domain中,则User.hbm.xml也位于此包中

spring的applicationContext.xml放在 "src"目录下


二、关于注释规范

类注释模板:http://blog.csdn.net/ljphhj/article/details/19676505 


你可能感兴趣的:(关于项目中制定的基本规范)