-
代码编写规范目的:
能够在编码过程中实现规范化,
为以后的程序开发中养成良好的行为习
惯。
代码编写规范使用范围:
J2EE
项目开发。
包命名规范:
目的:包的命名规范应当体现出项目资源良好的划分
servlet
类所在包命名规范:
公司名称
.
开发组名称
.
项目名称
.t
例如:
t
自定义标签类所在包命名规范:公司名称
.
开发组名称
.
项目名称
.
例如:
过滤器类所在包命名规范:公司名称
.
开发组
名称
.
项目名称
.
例如:
A
ction
类所在包命名规范:公司名称
.
开发组名称
.
项目名称
.
例如:
A
ctionForm
类所在包命名规范:公司名称
.
开发组名称
.
项目名称
.
例如:
J
avabean
所在包命名规范:公司名称
.
< br>开发组名称
.
项目名称
.
例如:
J
avabean
实现接口命名规范:公司名称
.
开发组名称
.
项目名称
.e
例如:
e
DAO
类所在包命名规范:公司名称
.
开发组名称
.
项目名称
.
例如:
D
AO
类所实现的接口在包中命名规范:公司名称
.
开发组名称
.
项目名称
.d
ao
例如:
POJO
类与
hbm
文件所在包命
名规范:公司名称
.
开发组名称
.
p>
项目名称
.
例如:
全
局公共类、接口类所在包命名规范:公司名称
.
开发组名称
p>
.
项目名称
.global
例如:
全
局工具类所在包命名规范:公司名称
.
开发组名称
.
项目名称
.util
例如:
类命名规范
基本命名规范:
类、接口命名
命名规范:以大写字母开头,如果有多个单词,每个单词头字母大写
例如:
StudentInfo
接口命名
命名规范:以大写字母
开头,如果有多个单词,每个单词头字母
大写
例如:
IStudentInfo
接口实现类命名:
命名规范:将实现
的接口名称的首字母
去掉,以
作为结尾
,如果有多个单词,每个
单词头字母大写。
例如:
StudentInfoImpl
J2EE+SSH
框架命名规范
servlet
类命名:
命名规范:以
Servlet
单词结尾
例如:
LoginServlet
POJO
命名:
使用
hibernate
自动生成的类即可
DAO
类命名:
使用
hibernate
自动生成的类即可
Action
类命名:
命名规范:
Action
的命名以
< br>POJO
名称来制定,
POJO
名称
Action
例如:
一个
POJO
名称为
D
iary
,其对应的
action
为<
/p>
DiaryAction
ActionForm
类命名:
p>
命名规范:
ActionForm
的命名以
POJO
名称来制定,
POJO
名称
Form
例如:
一个
POJO
名称为
Diary
,其对应的
actioForm
为
DiaryFo
rm
业务逻辑接口命名
:
命名规范:业务逻辑接口的命名以
POJO
名
称来制定,
IPOJO
名称
Servi
ce
例如:
一个
< br>POJO
名称为
Diary
,其
对应的业务逻辑接口为
IDiaryService
业务逻辑实现类命名
:
命名规范:业
务逻辑接口实现类的命名以
POJO
名称来制定
例如:
一个
POJO
名称为
Diary
,对应的业务逻辑接口实现类名为
DiaryServiceImpl
类变量命名:
命名规范:变量名首字母必须小写,如果该变量名有多个单词组成,后面的单
p>
词首字母大
写,
单词与单词之间不要使用<
/p>
做连接,
变量名访问控制必须为私有,<
/p>
可以对其增加
setter
与
getter
方法。
例如:
private int
studentAge;
public int getStudentAge(){
return studentAge;
}
public void setStudentAge(int
studentAge) {
tAge=studentAge;
}
常量命名:
命名规范:所有字母大写
,如果有多个单词组成,单词与单词之间以
”
_“
隔开。而
且该变量
必须是公共、静态、
final
类型
例如:
public static final
String US
ER_NAME=”userName“;
方法命名
命名规范:首字母必须小写,如果该变量名有多个单词组成,后面的单词首字母
大写,单
词与单词之间不要使用
做连接。单词不要使用名词。
例如:
public int
checkLogin
(
String
name,String pwd
)
{}
注释规范:注释规范是整个开发规范中最为重要的组成部分,
必须严格执行。
类的注释:
作用:注释整个类,简单概述该类作用。
书写规范:类的注释必须写在该类的声明语法之前。在注释中要描述该类的基
p>
本作用,作
者,日期,版本,公司名称,版权声明。
格式:
类的声明语法
例如:
public class AdminDAO
变量、常量注释:
作用:简单描述该变量的意义。
书写
规范:变量注释必须写在变量定义之前,简单描述其代表的意义。
格式:
例如:
public int age;
方法注释:
作用:对该方法功能简单描述,其参数、返回值意义的注解。
书写规范:方法注释必须写在方法定义之前。该注释包括:方法其功能的简单
描述,方法