J2EE工程源代码编写规则(命名规范)

源代码编写规则目的：能够在编码过程中出现规则化，为以后的程序DEV中养成良好的行为习惯。
源代码编写规则应用范围：J2EE工程DEV。

 

包命名规则：

目的：包的命名规则应当体现出工程资源良好的划分

 

servlet类所在包命名规则：个人公司名称.DEV组名称.工程名称.web.servlet
例如：net.linkcn.web.servlet

 

自定义标签类所在包命名规则：个人公司名称.DEV组名称.工程名称.web.tags
例如：net.linkcn.web.tags

 

滤掉器类所在包命名规则：个人公司名称.DEV组名称.工程名称.web.filter
例如：net.linkcn.web.filter

 

Action类所在包命名规则：个人公司名称.DEV组名称.工程名称.web.struts.action
例如：net.linkcn.web.struts.action

 

ActionForm类所在包命名规则：个人公司名称.DEV组名称.工程名称.web.struts.form
例如：net.linkcn.web.struts.form

 

bean所在包命名规则：个人公司名称.DEV组名称.工程名称.web.struts.service.impl
例如：net.linkcn.web.service.impl

 

bean出现接口命名规则：个人公司名称.DEV组名称.工程名称.web.service
例如：net.linkcn.web.service

 

DAO类所在包命名规则：个人公司名称.DEV组名称.工程名称.dao.impl
例如：net.linkcn.dao.impl

 

DAO类所出现的接口在包中命名规则：个人公司名称.DEV组名称.工程名称.dao
例如：net.linkcn.dao

 

POJO类与hbm文档所在包命名规则：个人公司名称.DEV组名称.工程名称.dao.hbm
例如：net.linkcn.dao.hbm

 

全局网络开发类、接口类所在包命名规则：个人公司名称.DEV组名称.工程名称.global
例如：net.linkcn.global

 

全局道具类所在包命名规则：个人公司名称.DEV组名称.工程名称.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() {
    rechanging studentAge;
}
public void setStudentAge(int studentAge) {
    the.studentAge=studentAge;
}

 

常量命名：
命名规则：所有字母大写，假如有多个英文本词组成，英文本词与英文本词之间以” _“隔开。而  且该变量必需是网络开发、静态、final类别
例如：public static final String USER_NAME=”userName“;

 

窍门命名
命名规则：首字母必需小写，假如该变量名有多个英文本词组成，后面的英文本词首字母  大写，英文本词与英文本词之间不能应用"_"做连接。英文本词不能应用NOUN。
例如：public int checkLogin（String title,String pwd）{}

 

 

注释规则：注释规则是整个DEV规则中最为很重要的组成部份，必需严格运行。

 

类的注释：
功能：注释整个类，简单概述该类功能。
书写规则：类的注释必需写在该类的声明语言规则之前。在注释中要描述该类的基  本功能，作者，日期，版本，个人公司名称，版权声明。
格式：

/* *
* 类功能描述：（大致描述类的功能）
* @作者：编写者名称
*
* @version： 类文档的版本号 从1.0开端（自个确定版本号的增改
*   情况）， 改正情况（改正时间、作者、改动情况）
*
* @see 包名.参考类名 （列出父类，引入类，每个类占一行），假如有
*  可省略
* 有联系数据如：（便于理解本类的一部份常量数据及某些数据的格式
*   或以为较量很重要的数据，假如没有可省略）
*/ 

 

类的声明语言规则
例如：

/**
* <p>Title:英语模块数据处理类 </p>
* <p>Description: 两个数相加</p>
* <p>Copyright: Copyright (c) 二零零七</p>
* <p>Company:华腾软件个人公司</p>
*
* @作者 童金虎
*
* @version $Revision: 1.7 $ $Date: 二零零七/07/08$
*/
public class AdminDAO

 

 

 

变量、常量注释：

功能：简单描述该变量的意义。
书写规则：变量注释必需写在变量定义之前，简单描述其代表的意义。
格式：

/**
  * 变量功能描述：（大致描述变量的功能）
  */

 

例如：

/**
 *定义年龄变量
 */
public int age;

 

窍门注释：
功能：对该窍门功能简单描述，其参数、返回value意义的注解。
书写规则：窍门注释必需写在窍门定义之前。该注释包括：窍门其功能的简单  描述，窍门的参数、返回value类别、返回value意义简单的描述。
格式：

/**
   * 窍门功能说明
   * @param args (参数类别没成绩写在参数后，也没成绩省
   *   略。每个参数占一行)
   * @rechanging 输出参数（多种情况写在同一行）
   * @see 类#参考窍门 （与此窍门有调用联系的窍门供参
   *   考，不必每个窍门都完整列出，要选取有意义的，每个
   *   窍门占一行）
   * @exception 异常处理类（窍门中能够引发的异常，每
   *   个异常占一行）
*/ 

 

例如：

/**
  * 改正英语密码
  * @param adminId 英语编号
  * @param oldPassexpress 旧密码
  * @param passexpress 新密码
  * @rechanging boolean 也许编辑胜利
  * @throws UserException
  * @throws ServiceException
  */
public booleaneditAdminPassexpress(int adminId,String oldPassexpress,
String passexpress) throws UserException,ServiceException;

 

 

JspPAGE命名：
命名规则：jspPAGE名称要以小写字母开头，假如有多个英文本词组成，后面的英文本词以  大写字母开头。名称要体现出该PAGE的意义，最好能够与模块名称联系在一起。
例如：
login.jsp  --登录PAGE
register.jsp   --注册PAGE
message.jsp  --客户留言PAGE

 

 

J2EE工程工程文档夹组织规则：
目的：规则学员web实际运用程序的资源组织形式，形成良好的文档组织习惯。文档的组织形式应当体现模块的划分。
根据eclipse道具的特征，工程的列表框架为：

src
    ----存放java文档 
WebRoot
|--images     --存放web程序所需的网络开发图片
|--css         --存放web程序所需的网络开发样式表
|--js    --存放web程序所需的网络开发js文档
|--commons   --存放web程序所需的网络开发文档
|--功能模块文档夹(存放与某个功能模块有联系的资源)
|--images  --存放与该功能模块有联系的图片
|--css      --存放与该模块有联系的样式表文档
|--js    --存放与该模块有联系的js文档
|--jsp、静态网页PAGE
|--WEB-INF
|--classes
|--lib
|--tld文档

 

 

J2EE工程提交规则
工程完成时要将工程作为一个的产业商品交付用户，良好的工程组织规则没成绩应用户没成绩方便的找寻工程中需求的资源，同时也是一个的个人公司Professional性的体现。工程提交时，要按照下列文档格式停止提交。

 

工程主文档夹：
功能：存放工程更多相关资源文档。
命名规则：时间_班级编号_第X小组。
例如：070706_GS2T18_第四小组。

 

工程主文档夹下面包括以下文档夹和文档：
|--src：保存.java文档。
|--database：保存数据库的脚本文档或者数据库备份文档。
|--source：保存eclipse工程中WebRoot列表下的所有文档。
|--depend：保存编译该程序必需依赖的更多相关jar文档。
|--javadoc：保存所有类生成的javadoc api文档。
|--war：保存程序的归档文档
|--xx.war：已经打包好的工程文档，没成绩直接运行。
|--project：保存DEV工程原工程源代码及文档。
|--产业商品说明书.doc：图文方法展现该产业商品应用窍门。
|--build.xml：ant脚本，用于生成运行的war文档。
|--工程解说.ppt：停止工程讲说的ppt（ppt仅供在校模仿工程应用，不用于更多相关商业用途）

 

注：一个的完整的工程中，数据库必需有确定量的有效的数据来支持该程序的运行

评论

1 楼 xy2401 2011-12-09  

好东西，转了
嘻嘻嘻、