文档介绍:密级:内部
J2EE软件开发规范
(草稿)
版本:
北京银都新天地科技有限公司
总页数
28
正文
20
附录
生效日期: 年 月 日
编制:魏征
审核:
批准:
ﻬ文件变化记录单
版本编号
*状态
简要说明
变更人
变更日期
批准人
批准日期
A
魏征
2010-11-26
*状态:A——增加,M——修改,D——删除
ﻬ目 录
1 文档介绍ﻩ5
1.1 文档目的ﻩ5
文档范围ﻩ5
2ﻩ设计规范 5
2.1ﻩJava源代码规范 5
.1ﻩ开发环境 5
6
/html规范ﻩ7
7
2. 命名 7
代码格式 7
2. 数据库建模 8
.2 主要对象命名规范设计 8
SQL源代码编码规范设计ﻩ10
2.4ﻩ其他规范ﻩ11
11
2.4.2 配置库的使用ﻩ11
11
3ﻩ开发框架 11
目录结构ﻩ13
目录说明ﻩ13
3.2ﻩ系统参数 16
说明ﻩ16
.2ﻩ使用方法 17
.3ﻩ例程 17
数据库连接ﻩ18
.1ﻩ说明ﻩ18
3.3.2ﻩ使用方法 18
事务ﻩ19
3.4.1 说明ﻩ19
3.4.2 使用方法 19
3. 例程 19
3.5 缓存 20
3. 20
3.5.2ﻩ包、类说明 21
21
3. 21
、类说明 22
.4 例程ﻩ22
23
23
4 关于其他开发框架ﻩ23
23
评审流程ﻩ23
5 关于项目中不使用规范中的开发框架ﻩ24
ﻬ
文档介绍
文档目的
该文档是针对J2EE项目软件开发规范,用于规范各项目开发以及产品研发,使软件开发过程有章可循,保证软件质量,加强开发管理。
文档范围
适用于:项目经理,架构设计师、开发人员等进行的开发工作。
设计规范
Java源代码规范
开发环境
,不建议使用最新版本IDE
所有java源文件编码格式为UTF-8
命名
Package 的命名
Package 的名字应该都是由一个小写单词组成,例如:。
此外,对于包名我们做如下约定:
test
action类包名前缀为.action
model类包名前缀为.model
Class 的命名
Class 的名字必须由大写字母开头而其他字母都小写的单词组成,例如:Data。
Class 变量的命名
变量的名字必须用一个小写字母开头。后面的单词用大写字母开头,例如:debug 或 input。
Static Final 变量的命名
Static Final 变量的名字应该都大写,并且指出完整含义,例SORT_COLUMN="id"。
参数的命名
参数的名字必须和变量的命名规范一致。
方法的参数
使用有意义的参数命名,如果可能的话,使用和要赋值的字段一样的名字:
setCounter(int size)
{
= size;
}
代码格式
文件头声明
源文件的头部需要一个history段,对于每次对源文件的重大改动,都需要在history段中注明。该段定义代码顶部,例如:
/**********************************************