Eclipse中的checkstyle插件

原创 2013年12月06日 10:16:31

一、Checkstyle工具

Checkstyle是一款检查Java程序源代码样式的工具,它可以有效的帮助我们检视代码以便更好的遵循代码编写标准。

官方地址:http://checkstyle.sourceforge.net/

 

二、在Eclipse中安装Checkstyle插件

1.地址: http://eclipse-cs.sourceforge.net/update

2.使用过程

安装环境:Eclipse3.5

(1)安装界面

 

(2)项目属性中选择checkstyle,并勾选“checkstyle active for this project"开启项目的代码样式检查

 

(3)可以配置某一代码样式属性,比如:”Maximum Method Length"

 

(4)可以选择远程或者本地的checkstyle配置文件

 

三、配置文件

配置文件是XML格式的,可以配置方法最大行数,代码行最大字符数等等很多,具体见:http://checkstyle.sourceforge.net/config.html

 

 

四、checkStyle 使用
 
选中工程,右键选择checkstyle->check code with checkstyle,检查错误即可
 
五、Checkstyle的结果输出
 
序号      输出内容意义
1 Type is missing a javadoc commentClass  缺少类型说明
2“{” should be on the previous line “{” 应该位于前一行
3Methos is missing a javadoc comment方法前面缺少javadoc注释
4Expected @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“}” 应该与下条语句位于同一行
10Unused @param tag for “unused”没有参数“unused”,不需注释
11Variable “CA” missing javadoc变量“CA”缺少javadoc注释
12Line longer than 80characters行长度超过80
13Line contains a tab character行含有”tab” 字符
14Redundant “Public” modifier冗余的“public” modifier
15Final modifier out of order with the JSL suggestionFinal modifier的顺序错误
16Avoid using the “.*” form of importImport格式避免使用“.*”
17Redundant import from the same package从同一个包中Import内容
18Unused import-java.util.listImport进来的java.util.list没有被使用
19Duplicate import to line 13重复Import同一个内容
20Import from illegal package从非法包中 Import内容
21“while” construct must use “{}”“while” 语句缺少“{}”
22Variable “sTest1” must be private and have accessor method变量“sTest1”应该是private的,并且有调用它的方法
23Variable “ABC” must match pattern “^[a-z][a-zA-Z0-9]*$”变量“ABC”不符合命名规则“^[a-z][a-zA-Z0-9]*$”

相关文章推荐

Eclipse安装checkstyle插件

什么是checkstyle CheckStyle是SourceForge下的一个项目,提供了一个帮助JAVA开发人员遵守某些编码规范的工具。它能够自动化代码规范检查过程,从而使得开发人员从...

checkstyle安装-eclipse插件装法

  • 2008年12月04日 10:35
  • 312KB
  • 下载

在MyEclipse8.0上安装Checkstyle插件报“missing bundle org.eclipse.core.net”错误

eclipse-cs是checkstyle的eclipse插件(以下简称cs),可以帮助检查Java代码在格式和规范等方面的问题,是一个比较好用的软件(插件)。eclipse-cs主页 目前的cs最...

Eclipse checkstyle 插件

  • 2013年10月09日 10:36
  • 8.19MB
  • 下载

checkstyle eclipse 插件

  • 2016年09月29日 17:05
  • 20.82MB
  • 下载

myeclipse和eclipse插件checkstyle

1. myeclipse中安装checkstyle 1.1 下载和安装 (1)需要下载eclipse的checkstyle插件 链接:http://sourceforge.net/projects/...

提高Java代码质量的Eclipse插件之Checkstyle的使用详解

CheckStyle是SourceForge下的一个项目,提供了一个帮助JAVA开发人员遵守某些编码规范的工具。它能够自动化代码规范检查过程,从而使得开发人员从这项重要但是枯燥的任务中解脱出来。 ...
  • jjr520
  • jjr520
  • 2014年12月20日 19:51
  • 294
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:Eclipse中的checkstyle插件
举报原因:
原因补充:

(最多只允许输入30个字)