Java代码检查规范指导书

Java

代码检查规范指导书

审

核

:

批

准

:

日

期

:

日

期

:

实施日期

2010

< br>年

05

月

24

< br>日

版

本

号

A-0

密

级

内部

Copyright ? 2010

福富软件

版权所有

Java

代码检查规范——问题收集

文件编号：

修改履历

版本号

A-0

日期

2010-5-24

作者

吴兆彬

新作成

修订要点

Copyright ? 2010

福富软件

版权所有

Page

2

of

17

Java

代码检查规范——问题收集

文件编号：

目录

1

2

3

4

5

6

引言

. .................................................. .................................................. ...........................................

5

应用范围

.................................................. .................................................. ....................................

5

角色职责

.................................................. .................................................. ....................................

5

输入

. .................................................. .................................................. ...........................................

5

输出

. .................................................. .................................................. ...........................................

6

作业流程

.................................................. .................................................. ....................................

6

6.1

C

HECK

S

TYLE

安装与使用

....... .................................................. ................................................

7

6.1.1

CheckStyle

插件安装

.. .................................................. ...............................................

7

6.1.1.1

“在线更新”安装方式

................. .................................................. .........................................

7

6.1.1.2

“手动下载”安装方式

................. .................................................. .........................................

8

6.1.2

CheckStyle

的配置与使用

.................................................. .........................................

9

6.1.2.1

6.1.2.2

6.1.2.3

导入：规则文件

.

< br>............................................... .................................................. .................

9

启用：项目检查

.

< br>............................................... .................................................. ............... 10

查看：结果视图

.

< br>............................................... .................................................. ............... 10

6.2

E

CLIPSE

C

ODE

S

TYLE

的配置

.

< br>............................................... .................................................

10

6.2.1.1

“代码模版”的配置

....... .................................................. .................................................. ... 10

6.2.1.2

“

代码格式化”的配置

...... .................................................. .................................................. .. 11

6.2.1.3

“代码清理”的配置

....... .................................................. .................................................. ... 11

6.3

7

代码修正

....................................... .................................................. .................................... 11

问题反馈（

FAQ

）

< br> .............................................. .................................................. .....................

12

1)

2)

3)

4)

5)

为什么第一句话需要以标点符号结束？

.......... .................................................. ..................

12

“”}”

应该在同一行”的提示信息？

....................................... ...............................................

12

“

一个 局部常数，最好定义为全局常数”的提示信息？

................. ...................................

13

“

条件 逻辑语句应该被移除”的提示信息？

...................... ..................................................

13

“

变量 应该声明为

PRIVATE

”的提示信息？

.

........................ .................................................

13

Copyright ? 2010

福富软件

版权所有

Page

3

of

17

Java

代码检查规范——问题收集

文件编号：

6)

7)

8)

9)

“

工具 类不应该存在

PRIVATE

或者默认构造函数”的提示信息？

.....................................

14

“

参数 超过

7

个”的提示信息？