文档介绍：密级:机密
文件编号:D06-PDG062
JAVA编码规范
版本:-
2007-7-16
沈阳东软软件股份有限公司电信事业部
(版权所有,翻版必究)
文件修改控制
修改编号
版本
修改条款及内容
修改日期
1
-
新建
2006-8-31
2
-
修改:在“”中,增加源代码的版权标识
2007-7-16
3
-
修改:
2010-3-11
4
-
2010-3-19
目录
1. 引言 1
目的 1
参考资料 1
术语 1
2. 命名规范 1
命名约定 1
包命名规则 2
类命名规则 2
接口命名规则 3
Action类命名规则 3
业务逻辑类命名规则 3
数据操作类命名规则 3
数据库表对象封装类命名规则 3
数据库表对象封装集合类命名规则 3
方法命名规则 3
变量命名规则 4
常量命名规则 4
数据标签命名规则 4
页面元素命名规则 5
文件命名规则 5
业务类型列表 5
数据类型列表 5
文件类型列表 6
命名参考表 6
3. 注释规范 7
注释约定 7
文件注释规则 7
类注释规则 9
方法注释规则 9
变量注释规则 10
实现注释规则 10
单行注释规则 11
块注释规则 11
4. 编码格式规范 12
书写格式约定 12
缩进格式规范 12
行长度规范 12
换行规范 12
使用括号规范 13
JAVA格式规范 13
包声明语句 13
引入语句 13
类的声明 13
范例 14
引言
目的
本文是基于J2EE技术框架进行程序开发所应遵循的开发规范。按照此规范来开发可带来以下益处:
代码的编写保持一致性
提高代码的可读性和可维护性
易于程序员间代码共享,特别是在团队开发一个项目的情况下
易于代码的回顾
节省开发时间,当程序员采用了此规范后,不必再关注于编写代码的格式,而专注于代码的实现
保证代码的质量
提高程序质量
为以后的程序维护减轻负担
本文只是一个初版,并不能覆盖所有的情况,如果有遗漏,请予以补充。本文是不参照具体业务需求而定义的规范。
参考资料
无
术语
无
命名规范
命名约定
各程序对象在命名时要遵循如下规则:
命名要使用富有意义英文词汇,尽量避免使用缩写;对象的名称可由多个单词组成的。
对于在数据库中能直接对应的字段要与数据库字段去掉下划线及f前缀的单词保持一致。
命名只能使用英文字母,数字以及下划线;命名规则包括:
单词首字母大写,其它字母小写。(类和文件命名)
首单词字母小写,其它单词的首字母大写。(变量命名)
所有字母大写,单词间以下划线分隔。(常量命名)
避免名称过于相似,如两个名字只有1、2个字符不同。
名称不允许使用保留字和关键字,但保留字和关键字可作为对象名称的一部。
包命名规则
Java Package 的命名:
包的命名全部小写,由字母和数字组成。
多层次包级别间用点号区分。
,后续部分根据项目的统一规划而定;.neusoft开头;后面加上项目名称和模块名称,如CRM项目为crm,销售模块为sales,然后是业务功能单元名称。
. //东软-crm项目-sales模块-accept功能包
再根据具体类的功能划分为不同的包路径,如下:
.action action类路径
.bo 业务逻辑类路径
.dao 数据操作类路径
.data 表数据封装类路径
类命名规则
由字母和数字组成,采用大小写混合的方式:每个具有明确含义的单词的首字母大写,其他字母小写。