文档介绍：项目编号
200702007
文档编号
13
密级
内部
网上招聘系统编码规范及其代码说明
公司名
评审日期: 2007年6月12日
目录
3
3
3
3
4
4
4
4
2. 编码格式规范 4
2. 1缩进排版 5
2. 2行长度 5
2. 3断行规则: 5
2. 4空行 6
7
3. 1包(Packages) 7
3. 2类(Classes) 7
3. 3接口(Interfaces) 7
3. 4方法(Methods) 7
3. 5变量(Variables) 7
3. 6实例变量(Instance Variables) 8
3. 7常量(Constants) 8
8
8
8
9
9
9
9
10
10
10
6. 1注释的方法 10
6. 2开头注释 11
6. 3类和接口的注释 12
7. 代码范例 12
14
该文档的目的是描述网上招聘系统项目的编码规范和对代码的说明,其主要内容包括:
编码规范
命名规范
注释规范
语句规范
声明规范
目录设置
代码说明
本文档的预期的读者是:
开发人员
项目管理人员
质量保证人员
该文档定义了本项目的代码编写规范,以及部分代码描述和所有代码的说明。
JSP
Java Server Page(Java服务器页面)的缩写,一个脚本化的语言。
MVC
Model-View-Control(模式-视图-控制)的缩写,表示一个三层的结构体系。
EJB
Enterprise Java Bean(企业级JavaBean)的缩写。
Class
Java程序中的一个程序单位,可以生成很多的实例。
Packages
由很多的类组成的工作包。
[1] 《企业文档格式标准》
[2] 《Java语言编写规范》
[1] 《实战struct》〔美〕Ted Husted 机械工业出版社
[2] 《软件重构》清华大学出版社
本文档的更新记录如表D-1所示。
表D-1 版本更新记录
修改编号
修改日期
修改后版本
修改位置
修改内容概述
000
0. 1
全部
初始发布版本
001
6章
修改代码
2. 编码格式规范
2. 1缩进排版
4个空格作为缩进排版的一个单位。
2. 2行长度
尽量避免一行的长度超过80个字符,用于文档中的例子应该使用更短的行长,长度一般不超过70个字符。
2. 3断行规则:
当一个表达式无法容纳在一行内时,可以依据如下一般规则断开:
在一个逗号后面断开
在一个操作符前面断开
宁可选择较高级别(higher-level)的断开,而非较低级别(lower-level)的断开(见下面的例子)
新的一行应该与上一行同一级别表达式的开头处对齐
如果以上规则导致你的代码混乱或者使你的代码都堆挤在右边,那就代之以缩进8个空格
以下是两个断开算术表达式的例子。前者属于更高级别的断开,因为断开处位于括号表达式的外边。
longName1 = longName2 * (longName3 + longName4 - longName5)
+ 4 * longname6; //推荐
longName1 = longName2 * (longName3 + longName4
-longName5) + 4 * longname6; //避免
以下是两个缩进方法声明的例子。前者是常规情形。后者若使用常规的缩进方式将会使第二行和第三行移得很靠右,所以代之以缩进8个空格。
//规范的缩进
someMethod ( int anArg, Object anotherArg, String yetAnotherArg,
Object andStillAnother){
…
}
//以8个空格来缩进,以避免非常纵深的缩进
private static synchronized horkingLongMethodName(int anArg,
Object anotherAr