程序编码规范.docVIP

项目管理系统程序编码规范V1.0

PAGE

PAGE4

程序编码规范

V1.0

编写：×××

审核：×××

××××年××月修改

目录

TOC\o1-3\h\z\u一、引言 3

二、命名规范 3

2.1包（Package）的命名 3

2.2Class的命名 4

2.3Class变量的命名 4

2.4接口的命名 5

2.5参数的命名 5

2.6数组的命名 5

2.6方法的参数 6

三注释规范 6

3.1块注释(BlockComments) 7

3.2单行注释(Single-LineComments) 7

3.3尾端注释(TrailingComments) 7

3.4行末注释(End-Of-LineComments) 8

四Java文件样式 8

4.1版权信息 8

4.2Package/Imports 9

4.3Class 9

4.4ClassFields 10

4.5存取方法 10

4.6构造函数 10

4.7main方法 11

4.8换行(WrappingLines) 11

4.9行长度(LineLength) 13

4.10语句(Statements) 13

五排版格式 18

六JSP编码规范 19

七、文件与目录 20

八、日志规范 20

九、设计及技巧建议 21

9.1表现层 22

9.2业务层 22

9.3持久层 22

除了以下几个特例之外，命名时应始终采用完整的英文描述符。此外，一般应采用小写字母，但类名、接口名以及任何非初始单词的第一个字母要大写。

1、尽量使用完整的英文描述符

2、采用适用于相关领域的术语

3、采用大小写混合使名字可读

4、尽量少用缩写，但如果用了，要明智地使用，且在整个工程中统一

5、避免使用长的名字（小于15个字母是个好主意）

6、避免使用类似的名字，或者仅仅是大小写不同的名字

7、避免使用下划线（除表态常量等）

2.4接口的命名

书写规则与类名相似，如interfaceRasterDelegate；interfaceStoring；

方法(Methods)：方法名是一个动词，采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写，例如：

run();

runFast();

getBackground();

2.5参数的命名

参数的命名必须与变量的命名规范一致。

2.6数组的命名

数组应该用下面的方式来命名：

byte[]buffer;

而不是：

bytebuffer[];

2.6方法的参数

使用有意义的参数来命名，名字尽量和将要赋值的字段一致。例如：

SetCounter(intsize){

this.size=size;

}

三注释规范

一般情况下程序有两类注释：实现注释(implementationcomments)和文档注释(documentcomments)。实现注释是那些在C++中见过的，使用/*...*/和//界定的注释。文档注释(称为doccomments)是Java独有的，并由/**...*/界定。文档注释可以通过javadoc工具转换成HTML文件。

实现注释用来注释代码或者实现细节。文档注释从实现自由(implementation-free)的角度描述代码的规范。它可以使手头没有源码的开发人员读懂程序。注释是用来对代码进行的，并提供代码自身没有提供的附加信息。注释要包含有助于阅读和理解程序的相关信息。例如，相应的包如何被建立或位于哪个目录下之类的信息不应包括在注释中。

程序可以有4种实现注释的风格：块(block)、单行(single-line)、尾端(trailing)和行末(end-of-line)。

3.1块注释(BlockComments)

块注释通常是对文件、方法、数据结构和算法等提供描述，应置于每个文件的开始处或每个方法之前。块注释也可以用于其他地方，如方法的内部。在功能和方法内部的块注释应该和它所描述的代码具有一样的缩进格式。

块注释之首应该有一个空行，用于把块注释和代码分割开来，比如：

/*

*在这里写块注释

*/

3.2单行注释(Single-LineComments)

单行注释之前也应该有一个空行。若为可以