文档介绍：JAVA 编码规范
北京神州数码思特奇信息技术股份有限公司
研究院
1
一、JAVA 编码规范
编码规范概述
文件体系结构规则
文件命名规则
排版规则
注释规则
命名规则
变量
方法
可读性
程序效率
质量保证
2
制定编码规范的最主要的目的是为了对产出代码的长期维护。通常负责
维护代码的人大多都不是开发者本人,如果有一个统一的代码格式以及
说明就可以减少混淆提高理解速度。
范围
编码规范定义了所有代码编写者在编写Java代码时应遵守的一些规
则和****惯。
本规范采用以下术语描述:
规则:编程时强制必须遵守的原则。
建议:编程时必须加以考虑的原则。
示例:对此规则或建议给出例子。
3
文件体系规则
JSP文件目录结构
|――cgi 存放cgi程序 |――cgi-bin 存放cgi编译后的程序 |――css 存放样式表
|――html 存放临时生成的报表文件 |――images 存放图片 |――include 存放系统要引用的文件 |――js 存放javascript脚本
|――ocx 存放ocx控件
|――page 存放JSP页面 |――模块分类名
|――WEB-INF WEB 配置文件,class 文件
4
文件体系规则
Java文件目录结构
|――<模块分类目录> 模块分类
|――action 存放action(控制层)文件
|――dao 存放dao(数据层)文件
|――form 存放form(展示层)文件
|――service 存放业务逻辑文件
|――vo 存放数据对象文件
5
源文件结构规则
包和引入语句
先写包语句,再写引入语句。
package行和import行之间留一行空行。
引入的标准包名要在本地包名之前,并且包名按照字母顺序排列。
如果 import 行中包含了同一个包中的类超过5个,则用* 来处理。
import的标准包和本地包之间留一行空行。
示例:
.;
import ;
import ;
.;
.;
6
源文件结构规则
类/接口
先写类/接口注释,标明类/接口的用途、版本、作者等信息。
类/接口注释之后空一行,然后写类/接口声明。
extends 和 implements写在不同行。
异常也单写一行。
示例:
public class CounterSet
extends Observable
implements Cloneable
throws XXXXXX
7
源文件结构规则
类变量的声明顺序是 public,protected,package,private
公共变量(Public)
保护变量(Protected)
包一级别的变量(没有访问修饰符)
私有变量(Private)
8
源文件结构规则
变量、常量的注释应放在其上方相邻位置或右方
用递增的方式写构造器(比如:参数多的写在后面)
类变量的存取方法:get和set方法
如果定义main() 方法,必须将main方法写在类的底部
9
Struts配制文件命名
sc-
jsp文件命名
主文件
xxx命名详见附录A:词典规范
sxxxx 文件夹,xxxx为opcode
xxxx opcode,x序号
jsp文件命名
action文件
form文件
service文件
dao文件
vo文件
主键的vo文件
10