checkstyle常见错误

更多详情详见:

http://commons.apache.org/proper/commons-jelly/libs/http/checkstyle-report.html

1   提示：Type is missing a javadoc commentClass

说明：缺少类型说明

解决方法：增加javadoc说明

2   提示：“{” should be on the previous line

说明：“{”应该位于前一行。

解决方法：把“{”放到上一行去

3   提示：Methos is missing a javadoc comment

说明：方法前面缺少javadoc注释。

解决方法：添加javadoc注释

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

说明：“}” 应该与下条语句位于同一行。

解决方法：把“}”放到下一行的前面

10 提示：Unused @param tag for “unused”

说明：没有参数“unused”，不需注释

解决方法：“* @param unusedparameter additional(参数名称)” 把这行unused参数的注释去掉“

11 提示： Variable “CA” missingjavadoc

说明：变量“CA”缺少javadoc注释

解决方法：在“CA“变量前添加javadoc注释：/** CA. */（注意：一定记得加上CA后面的“.”）

12 提示： Line longer than 80characters

说明：行长度超过80  。

解决方法：把它分成多行写。必要时候，可以ctrl+shift+f

13 提示：Line contains a tab character

说明：行含有”tab” 字符。

14 提示：Redundant “Public” modifier

说明：冗余的“public” modifier   。

解决方法：冗余的“public”

15 提示：Final modifier out of order with the JSL suggestion  

说明：Final modifier的顺序错误

16 提示： Avoid using the “.*” formof import

说明：Import格式避免使用“.*”

17 提示：Redundant import from the same package

说明：从同一个包中Import内容

18 提示： Unusedimport-java.util.list

说明：Import 导入进来的java.util.list没有被使用。

解决方法：去掉导入的多余的类

19 提示：Duplicate import to line 13

说明：重复Import同一个内容   

解决方法：去掉导入的多余的类

20 提示： Import from illegalpackage

说明：从非法包中 Import内容

21 提示：“while” construct must use “{}” 

说明：“while” 语句缺少“{}”

22 提示： Variable “sTest1” must beprivate and have accessor method

说明：变量“sTest1”应该是private的，并且有调用它的方法

23 提示： Variable “ABC” must matchpattern “^[a-z][a-zA-Z0-9]*$”

说明：变量“ABC”不符合命名规则“^[a-z][a-zA-Z0-9]*$”

解决方法：把这个命名改成符合规则的命名 “aBC”

24 提示：“(” is followed by whitespace       “)”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 onestatement. 

说明： 至少有一个声明

解决方法：try{}catch(){}中的异常捕捉里面不能为空，在异常里面加一句话。如打印等

30 提示：'>' is not followed by whitespace.并且又有 '('is preceded with whitespace.

说明：定义集合和枚举的时候的时候，最后一个“>”后面要有空格，“（”前面不容许有空格。

解决方法：去掉泛型(通常是泛型的地方容易出这个问题)

31 提示：Got an exception - java.lang.RuntimeException: Unable to get classinformation for @throws tag 'SystemException'.

说明：不合理的throws。

解决方法：要确保某些类型，如某些类、接口不被throws。把声明的异常去掉。在实现类中抛出异常

网上参考解决方法：1、这是CheckStyle报的错。通常需要Refreh, clean/build这个Project.如果不行，可以尝试clean all projects, restart Eclipse.

2、因为编译好的类没有在checkstyle的classpath中.所以, 只要将编译好的class配置到在<checkstyle/>的classpath中就没有这个问题了.另外, 还发现checkstyle的line length好像也有点问题, 明明没有超过120个字符, 却还是报错.无奈, 我把Eclipse中java> code style > formatter中的Maximumline with改成了100, 然后format一下, 基本就没有问题了

32 提示： File does not end with anewline.

解决方法：删掉报错的类，新建一个同名的类，把代码全部复制过去

33 提示：Utility classes should not have a public or default constructor.

说明： 接口中的内部类中不应该有公共的或者默认的构造方法

解决方法：在内部类中，定义一个私有的构造方法，然后内部类声明为final类型。如果前面有static，那么final还必须放在static之后

34 提示：Variable 'functionCode' must be private and have accessor methods

说明：.变量要改成private然后提供访问的方法

解决方法：给这些变量的修饰符改成private，然后提供set，get方法，并加上对应的方法javadoc注释、参数注释。并在返回值和参数类型前添加final。并把调用了这个变量的地方改成通过方法访问

35 提示： 'X' hides a field.

说明：全局private int X;和局部publicFoo(int X)的X变量名字重复。
解决方法：把方法里面的参数名称改变下就可以了public Foo(int newBar)

36 提示： Got an exception -Unexpected character 0xfffd in identifier

说明：这是因为CheckStyle不能识别制定的编码格式。

网上参考解决方法：

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

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

<modulename="Checker">

<propertyname="severity" value="warning"/>

<property name="charset"value="UTF-8"/>

<modulename="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