偶看新闻洛阳个人水洗厂转让:Checkstyle使用参考
来源：百度文库 编辑：偶看新闻 时间：2024/04/29 01:54:25
简介
Checkstyle 是一个帮助开发者按照某种习惯编写 java 代码的工具，他实现了代码检查的自动化，帮助人们从这种繁琐的工作中解放出来。
默认提供了对 sun 编程规范的支持，但是 Checkstyle 是一个具有高可配置性的，你完全可以根据自己的要求来配置需要检查的内容。
下载安装
的下载安装
下载apache-ant-1.6.5-bin.zip，然后解压缩到C:/apache-ant-1.6.5（或其它路径下）。
添加新的环境变量ANT_HOME
添加新的变量值到环境变量Path中
在Dos窗口下输入ant回车，如果看到下图的内容，说明Ant已经成功安装了。
如果没看到上图的信息，请根据运行环境的实际情况检查下列信息
ANT_HOME = C:/apache-ant-1.6.5
JAVA_HOME = C:/j2sdk1.4.2_08
Path = %ANT_HOME%/bin;%JAVA_HOME%/bin;(后面还有很多，这里就省略了)
ClASSPATH = .;%JAVA_HOME%/jre/lib/rt.jar;%JAVA_HOME%/lib/tools.jar
(注意上面一行等号后面是个点“.” 后面接分号)
的下载安装
下载checkstyle-4.2.zip，然后解压缩到C:/checkstyle-4.2（或其它路径下），下文提到这个路径时将使用CHECKSTYLE_HOME代替。
将CHECKSTYLE_HOME目录下的checkstyle-optional-4.2.jar拷贝到ANT_HOME/lib目录下
．使用Ant实现代码检查
使用Ant实现代码检查，我们共需要三个文件build.xml, user.properties和sunrising_checks.xml，下面分别对讲解这三个文件。
这个文件是将要在build.xml中用的属性文件，用户可以自定义下面的常用的属性
# 项目名称
project.name=TopShelf
# 项目所在的路径
project.dir=F/://eclipse//WorkSpace20061012//WordEmTest
# 源文件所在的路径
project.src.dir=${project.dir}//src
# 报告生成的位置, 默认的位置为${project.dir}//report
# 如果需要在其它位置生成报告, 请删除下面一行前面的"#",并且在等号后面给出路径
# project.checkstyle.report.dir=new path here
# 检测结果文件名, 默认为${project.name}-checkstyle-result-${DSTAMP}.xml
# 如果需要在改成其它的文件名, 请删除下面一行前面的"#",并且在等号后面给出新的文件名
# project.check.result.name=new name here
# 检测报告文件名, 默认为${project.name}-checkstyle-report-${DSTAMP}.html
# 如果需要在改成其它的文件名, 请删除下面一行前面的"#",并且在等号后面给出新的文件名
# project.check.report.name=new name here
# checkstyle的配置文件, 默认的配置文件为${basedir}/sunrising_checks.xml
# 如果需要使用其它的配置文件, 请删除下面一行前面的"#",并且在等号后面给出配置文件的路径
# checkstyle.config=new path here
# checkstyle的报告风格, 默认值为${basedir}/contrib/checkstyle-noframes.xsl
# checkstyle.report.style=new style here
这个文件是运行Ant时需要用的文件
这个文件是Checkstyle在执行代码检测时需要用的配置文件，里面定义的检查规则。详细的规则定义将在第四节做详细介绍。
执行步骤
A) 将上面提到的三个文件拷贝到CHECKSTYLE_HOME目录下
B) 打开DOS窗口进入到CHECKSTYLE_HOME目录下
C) 输入ant，然后回车，如果能看到BUILD SUCCESSFUL就成功了。
安装Checkstyle的Eclipse的插件
A) 首选下载Checkstyle的Eclipse的插件－com.atlassw.tools.eclipse.checkstyle_4.1.1-bin.zip
B) 将插件解压缩后，将features和plugins和文件夹中的内容拷贝到Eclipse下对应的文件夹下
C) 删除ECLIPSE_HOME/configuration/下的org.eclipse.update文件夹，然后重新启动Eclipse
在Eclipse中使用Checkstyle
A) 插件安装成功后，在Eclipse中点击Window->Preferences选项可以看到下图
B) 在项目上使用Checkstyle。右键单击项目，选择Properties选项后可以看到下图
1) 选择Checkstyle
2) 选中Check Box－Checkstyle active for this project
3) 从下拉列表中选择一个Checkstyle的配置文件
4) 点击OK
查看项目中的任意一个源文件，可以看到类似下图的情况：
将鼠标指向图中的放大镜处稍做停留便可看到提示信息，如图片中的”Missing a Javadoc comment.”
配置文件的简要说明
关于配置文件的各个模块的更多细节，请参考CHECKSTYLE_HOME/docs/index.html
"http://www.puppycrawl.com/dtds/configuration_1_2.dtd">
常见的输出结果
1．Type is missing a javadoc commentClass
缺少类型说明
2．“{” should be on the previous line
“{” 应该位于前一行
3．Methods is missing a javadoc comment
方法前面缺少javadoc注释
4．Expected @throws tag for “Exception”
在注释中希望有@throws的说明
5．“.” Is preceeded with whitespace “.”
前面不能有空格
6．“.” Is followed by whitespace“.”
后面不能有空格
7．“=” is not preceeded with whitespace
“=” 前面缺少空格
8．“=” is not followed with whitespace
“=” 后面缺少空格
9．“}” should be on the same line
“}” 应该与下条语句位于同一行
10．Unused @param tag for “unused”
没有参数“unused”，不需注释
11．Variable “CA” missing javadoc
变量“CA”缺少javadoc注释
12．Line longer than 80characters
行长度超过80
13．Line contains a tab character
行含有”tab” 字符
14．Redundant “Public” modifier
冗余的“public” modifier
15．Final modifier out of order with the JSL
suggestionFinal modifier的顺序错误
16．Avoid using the “.*” form of import
Import格式避免使用“.*”
17．Redundant import from the same package
从同一个包中Import内容
18．Unused import-java.util.list
Import进来的java.util.list没有被使用
19．Duplicate import to line 13
重复Import同一个内容
20．Import from illegal package
从非法包中 Import内容
21．“while” construct must use “{}”
“while” 语句缺少“{}”
22．Variable “sTest1” must be private and have accessor method
变量“sTest1”应该是private的，并且有调用它的方法
23．Variable “ABC” must match pattern “^[a-z][a-zA-Z0-9]*$”
变量“ABC”不符合命名规则“^[a-z][a-zA-Z0-9]*$”
24．“(” is followed by whitespace
“(” 后面不能有空格
25．“)” is proceeded by whitespace
“)” 前面不能有空格
Checkstyle 是一个帮助开发者按照某种习惯编写 java 代码的工具，他实现了代码检查的自动化，帮助人们从这种繁琐的工作中解放出来。
默认提供了对 sun 编程规范的支持，但是 Checkstyle 是一个具有高可配置性的，你完全可以根据自己的要求来配置需要检查的内容。
下载安装
的下载安装
下载apache-ant-1.6.5-bin.zip，然后解压缩到C:/apache-ant-1.6.5（或其它路径下）。
添加新的环境变量ANT_HOME
添加新的变量值到环境变量Path中
在Dos窗口下输入ant回车，如果看到下图的内容，说明Ant已经成功安装了。
如果没看到上图的信息，请根据运行环境的实际情况检查下列信息
ANT_HOME = C:/apache-ant-1.6.5
JAVA_HOME = C:/j2sdk1.4.2_08
Path = %ANT_HOME%/bin;%JAVA_HOME%/bin;(后面还有很多，这里就省略了)
ClASSPATH = .;%JAVA_HOME%/jre/lib/rt.jar;%JAVA_HOME%/lib/tools.jar
(注意上面一行等号后面是个点“.” 后面接分号)
的下载安装
下载checkstyle-4.2.zip，然后解压缩到C:/checkstyle-4.2（或其它路径下），下文提到这个路径时将使用CHECKSTYLE_HOME代替。
将CHECKSTYLE_HOME目录下的checkstyle-optional-4.2.jar拷贝到ANT_HOME/lib目录下
．使用Ant实现代码检查
使用Ant实现代码检查，我们共需要三个文件build.xml, user.properties和sunrising_checks.xml，下面分别对讲解这三个文件。
这个文件是将要在build.xml中用的属性文件，用户可以自定义下面的常用的属性
# 项目名称
project.name=TopShelf
# 项目所在的路径
project.dir=F/://eclipse//WorkSpace20061012//WordEmTest
# 源文件所在的路径
project.src.dir=${project.dir}//src
# 报告生成的位置, 默认的位置为${project.dir}//report
# 如果需要在其它位置生成报告, 请删除下面一行前面的"#",并且在等号后面给出路径
# project.checkstyle.report.dir=new path here
# 检测结果文件名, 默认为${project.name}-checkstyle-result-${DSTAMP}.xml
# 如果需要在改成其它的文件名, 请删除下面一行前面的"#",并且在等号后面给出新的文件名
# project.check.result.name=new name here
# 检测报告文件名, 默认为${project.name}-checkstyle-report-${DSTAMP}.html
# 如果需要在改成其它的文件名, 请删除下面一行前面的"#",并且在等号后面给出新的文件名
# project.check.report.name=new name here
# checkstyle的配置文件, 默认的配置文件为${basedir}/sunrising_checks.xml
# 如果需要使用其它的配置文件, 请删除下面一行前面的"#",并且在等号后面给出配置文件的路径
# checkstyle.config=new path here
# checkstyle的报告风格, 默认值为${basedir}/contrib/checkstyle-noframes.xsl
# checkstyle.report.style=new style here
这个文件是运行Ant时需要用的文件
这个文件是Checkstyle在执行代码检测时需要用的配置文件，里面定义的检查规则。详细的规则定义将在第四节做详细介绍。
执行步骤
A) 将上面提到的三个文件拷贝到CHECKSTYLE_HOME目录下
B) 打开DOS窗口进入到CHECKSTYLE_HOME目录下
C) 输入ant，然后回车，如果能看到BUILD SUCCESSFUL就成功了。
安装Checkstyle的Eclipse的插件
A) 首选下载Checkstyle的Eclipse的插件－com.atlassw.tools.eclipse.checkstyle_4.1.1-bin.zip
B) 将插件解压缩后，将features和plugins和文件夹中的内容拷贝到Eclipse下对应的文件夹下
C) 删除ECLIPSE_HOME/configuration/下的org.eclipse.update文件夹，然后重新启动Eclipse
在Eclipse中使用Checkstyle
A) 插件安装成功后，在Eclipse中点击Window->Preferences选项可以看到下图
B) 在项目上使用Checkstyle。右键单击项目，选择Properties选项后可以看到下图
1) 选择Checkstyle
2) 选中Check Box－Checkstyle active for this project
3) 从下拉列表中选择一个Checkstyle的配置文件
4) 点击OK
查看项目中的任意一个源文件，可以看到类似下图的情况：
将鼠标指向图中的放大镜处稍做停留便可看到提示信息，如图片中的”Missing a Javadoc comment.”
配置文件的简要说明
关于配置文件的各个模块的更多细节，请参考CHECKSTYLE_HOME/docs/index.html
"http://www.puppycrawl.com/dtds/configuration_1_2.dtd">
常见的输出结果
1．Type is missing a javadoc commentClass
缺少类型说明
2．“{” should be on the previous line
“{” 应该位于前一行
3．Methods is missing a javadoc comment
方法前面缺少javadoc注释
4．Expected @throws tag for “Exception”
在注释中希望有@throws的说明
5．“.” Is preceeded with whitespace “.”
前面不能有空格
6．“.” Is followed by whitespace“.”
后面不能有空格
7．“=” is not preceeded with whitespace
“=” 前面缺少空格
8．“=” is not followed with whitespace
“=” 后面缺少空格
9．“}” should be on the same line
“}” 应该与下条语句位于同一行
10．Unused @param tag for “unused”
没有参数“unused”，不需注释
11．Variable “CA” missing javadoc
变量“CA”缺少javadoc注释
12．Line longer than 80characters
行长度超过80
13．Line contains a tab character
行含有”tab” 字符
14．Redundant “Public” modifier
冗余的“public” modifier
15．Final modifier out of order with the JSL
suggestionFinal modifier的顺序错误
16．Avoid using the “.*” form of import
Import格式避免使用“.*”
17．Redundant import from the same package
从同一个包中Import内容
18．Unused import-java.util.list
Import进来的java.util.list没有被使用
19．Duplicate import to line 13
重复Import同一个内容
20．Import from illegal package
从非法包中 Import内容
21．“while” construct must use “{}”
“while” 语句缺少“{}”
22．Variable “sTest1” must be private and have accessor method
变量“sTest1”应该是private的，并且有调用它的方法
23．Variable “ABC” must match pattern “^[a-z][a-zA-Z0-9]*$”
变量“ABC”不符合命名规则“^[a-z][a-zA-Z0-9]*$”
24．“(” is followed by whitespace
“(” 后面不能有空格
25．“)” is proceeded by whitespace
“)” 前面不能有空格
请使用e680i的朋友帮忙参考一下！
参考参考
谁能找到 <Oracle 7 使用与参考大全> 电子版?
如何使用胶卷包装合上的室外摄影暴光参考表
ISO定义的协议OSI参考模型使用层次结构，共发为八层??
谁有项目计划书？什么计划书都行。参考学习使用。谢谢
为什么OFFICE 2003帮助里面的OFFICE XP VISUAL BASIC 语言参考不能使用
w32dasm在反汇编文件后为什么使用不了"串式数据参考"功能?
机械设计使用的软件AUTOCAD有没有参考起来很好用的书呢？
参考参考好吗
给参考参考
进来参考参考~~
谁来帮我参考参考？？
大家来参考参考
请大家参考参考
大家快来帮参考参考
帮我参考参考
大家帮忙参考参考
帮我参考参考
买摩托车.参考参考...
帮忙来参考参考
大家帮忙参考参考
请使用诺基亚6030的朋友评价一下其有优缺点和南京的价格,作个买前参考.
大家把自己买的mp3使用感受分享一下（可以给想买mp3的人作参考）