checkstyle eclipse plugin v8.12 官方版

CheckStyle将可以为你带来在eclipse中所可以用的样式插件，叫你可以更好地进行各项编程操作，为你提供各类样式的制作带来最好的编程成效，轻松达成所需的各类编程功能！

官方介绍

是SourceForge下的一个项目，提供了一个帮助JAVA开发职员遵守某些编码规范的工具。它可以智能化代码规范检查过程，从而使得开发职员从这项要紧，但枯燥的任务中解脱出来。

安装办法：

下载成功后，将文件解压，会有两个文件夹features和plugins，将两文件夹下的内容分别复制到myeclipse 6.0\eclipse下面的features和plugins两个文件夹下，重新启动myeclipse，在window--gt;preferences下面可以看到Checkstyle

办法1、

1.Eclipse中，选择Help-Software Updates-Find and Install

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

3.选择 New Remote Site

4.输入更新地址

http://eclipse-cs.sourceforge.net/update

5. 安装后重启即可

办法2、

1.下载eclipse插件

下载后，把里面的两个文件夹plugins和 features下面的文件分别拷贝到eclipse目录下面对应的plugins和features目录

2.假如你就如此直接启动eclipse 或许会出现ClassNotFoundExceptions 等错误，所以需要在启动eclipse的时候加上一个参数 -clean. 如此eclipse就能更新它目前安装的很多插件信息

譬如你得eclipse在d盘 那样就是 d:\eclipse\eclipse.exe -clean

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]*$”

24“” is proceeded by whitespace“)” 前面不可以有空格

容易见到提示讲解：

1Type is missing a javadoc commentClass 缺少种类说明

2“{” should be on the previous line“{” 应该坐落于前一行。解决方案：把“{”放到上一行去

3Methos is missing a javadoc comment 办法前面缺少javadoc注解。解决方案：添加javadoc注解 类似如此：

/**

* set default mock parameter.（办法说明）

* @param additionalParameters parameter additional

* @return data manager

* @throws Exception if has error

*/

4 Expected @throws tag for “Exception”在注解中期望有@throws的说明

解决方案：在办法前得注解中添加如此一行：* @throws Exception if has error

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”，不需注解

解决方案：“* @param unused parameter additional” 把这行unused参数的注解去掉“

11 Variable “CA” missing javadoc变量“CA”缺少javadoc注解

解决方案：在“CA“变量前添加javadoc注解：/** CA. */（注意：肯定记得加上“.”）

12 Line longer than 80characters行长度超越80 。解决方案：把它分成多行写。必要时候，可以ctrl+shift+f

13 Line contains a tab character行含有”tab” 字符。迅速解决方案：可以用EditPlus中的format功能，把tab字符转化为空格，然后保存EditPlus英文版安装文件在我机子上有。需要的可以来拷贝。注册Editplus，点击安装文件中注册的文件

14 Redundant “Public” modifier冗余的“public” modifier。解决方案：冗余的“public”

15 Final modifier out of order with the JSL suggestion Final modifier的顺序错误

16 Avoid using the “.*” form of importImport格式防止用“.*”

17 Redundant import from the same package从同一个包中Import内容

18 Unused import-java.util.listImport进去的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]*$”解决方案：把这个命名改成符合规则的命名 “aBC”

24 “”is proceeded by whitespace“)” 前面不可以有空格

解决方案：把前面或者后面的空格去掉

25 First sentence should end with a period.解决方案：你的注解的第一行文字结束应该加上一个.。

26 Redundant throws: NameNotFoundException is subclass of NamingException. NameNotFoundException 是NamingException的子类重复抛出异常。

解决方案：假如抛出两个异常，一个异常类是另一个的子类，那样仅需写父类

去掉NameNotFoundException异常，对应的javadoc注解异常注解说明也需要去掉

27 Parameter docType should be final. 参数docType应该为final种类 解决方案：在参数docType前面加个final

28 Line has trailing spaces. 多余的空行 解决方案：去掉这行空行

29 Must have at least one statement. 至少一个声明

解决方案：} catch {

LOG.error;//异常捕捉里面不可以为空，在异常里面加一句话。如打印等等

30 is not followed by whitespace.并且又有

{

this.bar = bar;

}

public final int getBar

{

return bar;

}

}

全局private int bar;和局部public Foo的bar变量名字重复。

解决方案：把办法里面的参数名字改变下就能了public Foo

{

this.bar = newBar;

}。

36 Got an exception - Unexpected character 0xfffd in identifier

这是由于CheckStyle不可以辨别拟定的编码格式。

网上参考解决方案：

1、Eclipse中可以配置，在Other--checker中可以指定

2、可以修改checkstyle配置文件：

module name=Checker

property name=severity value=warning/

property name=charset value=UTF-8/

module name=TreeWalker

若是UTF-8的话，就添加加粗斜体的那条语句，就能了。

37 Got an exception - java.lang.RuntimeException: Unable to get class information for @throws tag *whatever*.

网上参考解决方案：选中CheckSytle的JavaDoc -- Method JavaDoc -- logLoadErrors。若是CheckStyle自己加载时出错的，打个Log就能了，不要整出Errors吓人。

还有一处也会包出同样的错误。Coding Problems -- Redundant Throws -- logLoadErrors选中即可

38 Expected @param tag for dataManager. 缺少dataManager参数的注解解决方案：在注解中添加@param dataManager DataManager

网上一些其他错误的解答：

1. Parameter X should be final.

public class Foo

{

private int bar;

public Foo

{

this.bar = bar;

}

public final int getBar

{

return bar;

}

}

讲解：public Foo的局部变量，被觉得是不可改变的，检查需要加上final关键词概念public Foo此错误，可以忽视不检查。

2. Redundant X modifier.

public interface CacheHRTreeService extends Manager {

/**

* Organization Tree

* @param orgDto

* @return

* @throws Exception

*/

public void setOrganization throws Exception;

/**

* Organization Tree

* @return

* @throws Exception

*/

public OrganizationDTO getOrganization throws Exception;

......

}

讲解：多余的字段。public OrganizationDTO getOrganization throws Exception;此时public为多余的字段，由于interface概念的时候，就是public的。

需要检查。

3. - Class X should be declared as final.

讲解：对于单例设计模式，需要返回唯一的类对象。但HRFactory和ContextFactory为优化的两个类，不需要检查。

其他的单例类，依旧需要进行检查。

4. - Method addChildrenId is not designed for extension - needs to be

abstract, final or empty.

讲解：通过父类继承的，此类有点特殊可以忽视此类。

5. Variable id must be private and have accessor methods.讲解：BaseHRDTO类，为父类，属性给子类继承，比较特殊。但其他的类，声名需要加上范围private关键词。需要检查。

6. -Array brackets at illegal position.讲解：代码写法，习惯不同。需要检查，仅仅提示

TAG标签：编程工具(4)eclipse(1)checkstyle(1)

转载请说明来源于谷普绿色软件（https://www.guixh.com）

本文地址：https://www.guixh.com/soft/3774.html

郑重声明：文章来源于网络作为参考，本站仅用于分享不存储任何下载资源,如果网站中图片和文字侵犯了您的版权，请联系我们处理！邮箱3450399331@qq.com