Java代码检查规范指导书

Java代码检查规范指导书

审核: 日期:

批准: 日期:

实施日期2010年05月24日

版本号A-0

密级内部

修改履历

目录

1引言 (5)

2应用范围 (5)

3角色职责 (5)

4输入 (5)

5输出 (6)

6作业流程 (6)

6.1C HECK S TYLE安装与使用 (7)

6.1.1CheckStyle插件安装 (7)

6.1.1.1“在线更新”安装方式 (7)

6.1.1.2“手动下载”安装方式 (7)

6.1.2CheckStyle的配置与使用 (9)

6.1.2.1导入：规则文件 (9)

6.1.2.2启用：项目检查 (10)

6.1.2.3查看：结果视图 (10)

6.2E CLIPSE C ODE S TYLE的配置 (10)

6.2.1.1“代码模版”的配置 (10)

6.2.1.2“代码格式化”的配置 (11)

6.2.1.3“代码清理”的配置 (11)

6.3代码修正 (11)

7问题反馈（FAQ） (12)

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

2)“”}”应该在同一行”的提示信息？ (12)

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

4)“条件逻辑语句应该被移除”的提示信息？ (13)

5)“变量应该声明为PRIVATE”的提示信息？ (13)

6)“工具类不应该存在PRIVATE或者默认构造函数”的提示信息？ (14)

7)“参数超过7个”的提示信息？ (14)

8)“类级的常量必须与模式”^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$”相匹配”的提示信息？

14

9)“避免在语句中出现嵌套的赋值语句”的提示信息？ (15)

1引言

在编码规范推进过程中，陆续收到很多开发人员提交上来的疑问，这里逐一统一做了一个整理和收集，做成能够为开发人员提供指导意见的工作流程，以提供大家互相参考和借鉴，共通把电信信息化部的编码风格做到一致，为编码质量的提高奠定基础。

收集上来的问题，主要包括：在插件安装上的困难；在CheckStyle提示信息上的疑问点；使用Eclipse Code Style中的自动修复功能的问题；期望实现的改进建议；

2应用范围

本指导书适用于编码阶段，可以进行代码的自查和修订，也可以适用于代码走查阶段。在纠正代码规范性的基础上，更利于开发人员从业务层面进行走查的效果。

3角色职责

4输入

1)《Java代码检查规范》；

2)《Eclipse Code Style设置》；

3)代码检查配置文件；（2010年大部检查标准_CheckStyle.xml）

4)代码修复工具；（2010年大部检查标准_template.xml、2010年大部

检查标准_formatter.xml、2010年大部检查标准_Clean Up.xml）

5)开发人员的代码；

5输出

1)检查结果报表（图、表）；

2)代码走查情况；

6作业流程

1)检查人员在开发环境（Eclipse）中进行插件的安装，可以选择手动下载

安装方式，也可以选择在线更新方式；

2)安装完CheckStyle之后，需要进行CheckStyle的配置；这里请选择

导入规则配置文件《2010年大部检查标准_CheckStyle.xml》；

3)在项目工程上，设置激活CheckStyle检查；

4)激活并编译项目工程后，打开CheckStyle检查结果视图，来查看检查

结果；

5)检查人员将检查报告发送给开发人员，由开发人员进行修复；

6)开发人员导入修复规则：“代码模板配置文件”《2010年大部检查标准

_template.xml》、“代码格式化配置文件”《2010年大部检查标准_formatter.xml》和“代码清理配置文件”《2010年大部检查标准_Clean Up.xml》。

7)开发人员执行CleanUp操作，完成自动修复代码操作；

8)对于无法自动化修复的代码，开发人员进行手动修复；

6.1CheckStyle安装与使用

6.1.1CheckStyle插件安装

根据大家的使用习惯，可以选择“在线更新”或者“手动下载”方式，进行CheckStyle的插件安装。

6.1.1.1“在线更新”安装方式

1.Eclipse 3.4以上版本的安装方式

2.Eclipse

3.3以下版本的安装方式

6.1.1.2“手动下载”安装方式

1.方式一：

（如果是低版本的Eclipse，请将dropins修改为links目录）

2.方式二：

（如果是低版本的Eclipse，请将dropins替换为links目录；）

6.1.2CheckStyle的配置与使用6.1.2.1导入：规则文件

6.1.2.2启用：项目检查

6.1.2.3查看：结果视图

6.2Eclipse Code Style的配置6.2.1.1“代码模版”的配置

6.2.1.2“代码格式化”的配置

6.2.1.3“代码清理”的配置

6.3代码修正

1.“代码模版配置”，适用于自动生成“注释”和“代码”时，套用的模版；

2.“代码格式化配置”，适用于配合“Ctrl + Shift + f”键来使用，完成

代码的自动格式化；（建议在代码提交之前，先执行代码格式化）

3.“代码清理配置”配合“Source菜单的Clean Up”功能来使用，完成

代码的自动清理；（建议在代码提交之前，先执行代码清理）

4.手动修复，针对个别无法自动化修正的操作，需要开发人员手动进行修

正；