⽬的：包的命名规范应当体现出项⽬资源良好的划分
servlet类所在包命名规范：公司名称.开发组名称.项⽬名称.web.servlet 例如：net.linkcn.web.servlet
⾃定义标签类所在包命名规范：公司名称.开发组名称.项⽬名称.web.tags 例如：net.linkcn.web.tags
过滤器类所在包命名规范：公司名称.开发组名称.项⽬名称.web.filter 例如：net.linkcn.web.filter
Action类所在包命名规范：公司名称.开发组名称.项⽬名称.web.struts.action 例如：net.linkcn.web.struts.action
ActionForm类所在包命名规范：公司名称.开发组名称.项⽬名称.web.struts.form 例如：net.linkcn.web.struts.form
Javabean所在包命名规范：公司名称.开发组名称.项⽬名称.web.struts.service.impl 例如：net.linkcn.web.service.impl
Javabean实现接⼝命名规范：公司名称.开发组名称.项⽬名称.web.service 例如：net.linkcn.web.service
DAO类所在包命名规范：公司名称.开发组名称.项⽬名称.dao.impl 例如：net.linkcn.dao.impl
DAO类所实现的接⼝在包中命名规范：公司名称.开发组名称.项⽬名称.dao 例如：net.linkcn.dao
POJO类与hbm⽂件所在包命名规范：公司名称.开发组名称.项⽬名称.dao.hbm 例如：net.linkcn.dao.hbm
全局公共类、接⼝类所在包命名规范：公司名称.开发组名称.项⽬名称.global 例如：net.linkcn.global
全局⼯具类所在包命名规范：公司名称.开发组名称.项⽬名称.util 例如：net.linkcn.util 类命名规范
基本命名规范： 类、接⼝命名
命名规范：以⼤写字母开头，如果有多个单词，每个单词头字母⼤写 例如：StudentInfo 接⼝命名
命名规范：以⼤写字母\"I\"开头，如果有多个单词，每个单词头字母⼤写 例如：IStudentInfo 接⼝实现类命名：
命名规范：将实现的接⼝名称的⾸字母\"I\"去掉，以\"Impl作为结尾\"，如果有多个单词，每个单词头字母⼤写。 例如：StudentInfoImpl J2EE+SSH框架命名规范 servlet类命名：
命名规范：以Servlet单词结尾 例如：LoginServlet POJO命名：
使⽤hibernate⾃动⽣成的类即可 DAO类命名：
使⽤hibernate⾃动⽣成的类即可 Action类命名：
命名规范：Action的命名以POJO名称来制定，POJO名称Action 例如：
⼀个POJO名称为Diary，其对应的action为DiaryAction ActionForm类命名：
命名规范：ActionForm的命名以POJO名称来制定，POJO名称Form 例如：
⼀个POJO名称为Diary，其对应的actioForm为DiaryForm 业务逻辑接⼝命名:
命名规范：业务逻辑接⼝的命名以POJO名称来制定，IPOJO名称Service 例如：
⼀个POJO名称为Diary，其对应的业务逻辑接⼝为IDiaryService 业务逻辑实现类命名:
命名规范：业务逻辑接⼝实现类的命名以POJO名称来制定 例如：
⼀个POJO名称为Diary，对应的业务逻辑接⼝实现类名为DiaryServiceImpl 类变量命名：
命名规范：变量名⾸字母必须⼩写，如果该变量名有多个单词组成，后⾯的单 词⾸字母⼤写，单词与单词之间不要使⽤\"_\"做连接，变量名访问控制必须为私有， 可以对其增加setter与getter⽅法。 例如：private int studentAge; public int getStudentAge() {
return studentAge; }
public void setStudentAge(int studentAge) {
this.studentAge=studentAge; }
常量命名：
命名规范：所有字母⼤写，如果有多个单词组成，单词与单词之间以” _“隔开。⽽ 且该变量必须是公共、静态、final类型 例如：public static final String USER_NAME=”userName“; ⽅法命名
命名规范：⾸字母必须⼩写，如果该变量名有多个单词组成，后⾯的单词⾸字母 ⼤写，单词与单词之间不要使⽤\"_\"做连接。单词不要使⽤名词。
例如：public int checkLogin（String name,String pwd）{}
注释规范：注释规范是整个开发规范中最为重要的组成部分，必须严格执⾏。 类的注释：
作⽤：注释整个类，简单概述该类作⽤。
书写规范：类的注释必须写在该类的声明语法之前。在注释中要描述该类的基 本作⽤，作者，⽇期，版本，公司名称，版权声明。 格式： /* *
* 类功能描述：（⼤致描述类的功能） * @author：编写者名称 *
* @version： 类⽂件的版本号 从1.0开始（⾃⼰确定版本号的增改 * 情况）， 修改情况（修改时间、作者、改动情况） *
* @see 包名.参考类名 （列出⽗类，引⼊类，每个类占⼀⾏），如果有 * 可省略
* 相关数据如：（便于理解本类的⼀些常量数据及某些数据的格式 * 或认为⽐较重要的数据，如果没有可省略） */
类的声明语法 例如： /** *
Title:管理员模块数据处理类 *
Description: 两个数相加 *
Copyright: Copyright (c) 2007 *
Company:华腾软件公司
*
* @author 童⾦虎 *
* @version $Revision: 1.7 $ $Date: 2007/07/08$
*/
public class AdminDAO 变量、常量注释：
作⽤：简单描述该变量的意义。
书写规范：变量注释必须写在变量定义之前，简单描述其代表的意义。 格式： /**
* 变量功能描述：（⼤致描述变量的功能） */
例如： /**
*定义年龄变量 */
public int age; ⽅法注释：
作⽤：对该⽅法功能简单描述，其参数、返回值意义的注解。
书写规范：⽅法注释必须写在⽅法定义之前。该注释包括：⽅法其功能的简单 描述，⽅法的参数、返回值类型、返回值意义简单的描述。 格式： /**
* ⽅法功能说明
* @param args (参数类型可以写在参数后，也可以省 * 略。每个参数占⼀⾏)
* @return 输出参数（多种情况写在同⼀⾏）
* @see 类#参考⽅法 （与此⽅法有调⽤关系的⽅法供参 * 考，不必每个⽅法都完整列出，要选择有意义的，每个 * ⽅法占⼀⾏）
* @exception 异常处理类（⽅法中能够引发的异常，每 * 个异常占⼀⾏） */
例如： /**
* 修改管理员密码
* @param adminId 管理员编号 * @param oldPassword 旧密码 * @param password 新密码
* @return boolean 是否编辑成功 * @throws UserException * @throws ServiceException */
public booleaneditAdminPassword(int adminId,String oldPassword, String password) throws UserException,ServiceException; Jsp页⾯命名：
命名规范：jsp页⾯名称要以⼩写字母开头，如果有多个单词组成，后⾯的单词以 ⼤写字母开头。名称要体现出该页⾯的意义，能够与模块名称联系在⼀起。 例如：
login.jsp --登录页⾯ register.jsp --注册页⾯
message.jsp --客户留⾔页⾯ J2EE项⽬⼯程⽂件夹组织规范：
⽬的：规范学员web应⽤程序的资源组织形式，形成良好的⽂件组织习惯。⽂件的组织形式应当体现模块的划分。 根据eclipse⼯具的特征，项⽬的⽬录结构为： src
----存放java⽂件 WebRoot
|--images --存放web程序所需的公共图⽚ |--css --存放web程序所需的公共样式表 |--js --存放web程序所需的公共js⽂件
|--commons --存放web程序所需的公共⽂件
|--功能模块⽂件夹(存放与某个功能模块相关的资源) |--images --存放与该功能模块相关的图⽚ |--css --存放与该模块相关的样式表⽂件
|--js --存放与该模块相关的js⽂件 |--jsp、html页⾯ |--WEB-INF |--classes |--lib
|--tld⽂件
J2EE项⽬提交规范
项⽬完成时要将项⽬作为⼀个产品交付⽤户，良好的项⽬组织规范可以使⽤户可以⽅便的找寻项⽬中需要的资源，同时也是⼀个公司专业性的体现。项⽬提交时，要按照下列⽂件格式进⾏提交。 项⽬主⽂件夹：
作⽤：存放项⽬其他资源⽂件。
命名规范：时间_班级编号_第X⼩组。 例如：070706_GS2T18_第四⼩组。
项⽬主⽂件夹下⾯包括以下⽂件夹和⽂件： |--src：保存.java⽂件。
|--database：保存数据库的脚本⽂件或者数据库备份⽂件。 |--source：保存eclipse⼯程中WebRoot⽬录下的所有⽂件。 |--depend：保存编译该程序必须依赖的其他jar⽂件。 |--javadoc：保存所有类⽣成的javadoc api⽂档。 |--war：保存程序的归档⽂件
|--xx.war：已经打包好的⼯程⽂件，可以直接运⾏。 |--project：保存开发项⽬原⼯程代码及⽂件。
|--产品说明书.doc：图⽂⽅式展现该产品使⽤⽅法。 |--build.xml：ant脚本，⽤于⽣成运⾏的war⽂件。
|--项⽬解说.ppt：进⾏项⽬讲解的ppt（ppt仅供在校模拟项⽬使⽤，不⽤于其他商业⽤途） 注：⼀个完整的项⽬中，数据库必须有⼀定量的有效的测试数据来⽀持该程序的运⾏
因篇幅问题不能全部显示，请点此查看更多更全内容