日期:2014-05-19 浏览次数:20760 次
源代码编写规则目的:能够在编码过程中出现规则化,为以后的程序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 旧密