Eclipse 配置Checkstyle

l         Checkstyle说明

介绍 Checkstyle是一个开发工具，可以帮助编程人员编写符合编码规范的java 代码 。程序员都非常讨厌程序的check工作，checkstyle能够自动地完成这项烦琐但又非常重要的工作 ，从而节省了的程序员的时间，也提高了检查的质量。Checkstyle已经成了加强编码规范的首选工具。

 

1           配置环境

操作系统	Windows XP + SP2
cpu	AMD Athlon™64 4000+ 双核
主板	865
内存	1G
硬盘	ST 160G
显卡	NVIDIA GeForce 8500GT
显示器	21寸宽屏
声卡网卡	内置
应用软件	Eclipse3.2+MyEclipse5.1.0

    注：1Mbit带防火墙功能的宽带路由器拨号上网，无固定IP

 

2           安装过程

方法一：通过更新网页

 

1。在Eclipse中，选择He lp->Software Updates->Find and Install

2.选择 Search for new features to install 选择Next

 

3.选择 New Remote Site

 

4.在名称中输入 Checkstyle Plug-in，在URL中输入：

5.然后继续安装就行了。

方法二：

 

1．你可以自己从 下载安装包，最新版的（2007/4/2）为4.3.0。

下载到之后，把里面的两个文件夹plugins和 features下面的文件分别放到eclipse 目录下面对应的plugins和features目录下。（别弄错了哦^_^)

2．清千万注意了，如果你就这样直接启动eclipse 可能会出现ClassNotFoundExceptions 等错误。你必须在启动eclipse的时候加上一个参数 -clean. 这样eclipse就可以更新它当前安装的许多插件信息。比如你得eclipse在d盘 那么就是 d:\eclipse\eclipse.exe –clean

特别注意 ：Eclipse 3.0 或者 更新版本 需要 4.0.0 或者更新版本支持。

 

3.使用

1．启动eclipse

2.Open the properties of the project you want to get checked

打开你要检查的项目的属性

 

 

  

 

4.接下来就可以看看你的代码符合规范与否了

 

 

第四部分 Checkstyle的结果输出含义

输出内容	内容含义
Type is missing a javadoc commentClass	缺少类型说明
“{” should be on the previous line “{”	应该位于前一行
Methos is missing a javadoc comment	方法前面缺少javadoc注释
Expected @throws tag for “Exception	在注释中希望有@throws的说明
“.” Is preceeded with whitespace “.	前面不能有空格
“.” Is followed by whitespace“.	后面不能有空格
“=” is not preceeded with whitespace“=	前面缺少空格
“=” is not followed with whitespace“=”	后面缺少空格
“}” should be on the same line“}”	应该与下条语句位于同一行
Unused @param tag for “unused”	没有参数“unused”，不需注释
Variable “CA” missing javado	变量“CA”缺少javadoc注释
Line longer than 80characters	行长度超过80
Line contains a tab character	行含有”tab” 字符
Redundant “Public” modifier	冗余的“public” modifier
Final modifier out of order with the JSL suggestionFinal	modifier的顺序错误
Avoid using the “.*” form of import	import格式避免使用“.*”
Redundant import from the same packag	从同一个包中Import内容
Unused import-java.util.list	import进来的java.util.list没有被使用
Duplicate import to line XXX	重复Import同一个内容
Import from illegal package	从非法包中 Import内容
“while” construct must use “{}”“while	“while” 语句缺少“{}”
Variable “sTest1” must be private and have accessor method	变量“sTest1”应该是private的，并且有调用它的方法
Variable “ABC” must match pattern “^[a-z][a-zA-Z0-9]*$”	变量“ABC”不符合命名规则“^[a-z][a-zA-Z0-9]*$”

 

在对话框中选择你要的checkStyle项目

请注意不要忘记了在左上角那个box打勾。如图。

3.Select the Checkstyle section within the properties dialog （鲁广校区 牛昊老师）