第01篇 提高代码质量插件
Posted 胖猿圈,码迷码迷吽!
tags:
篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了第01篇 提高代码质量插件相关的知识，希望对你有一定的参考价值。
我使用插件对我的代码进行分析，我这里使用的checkStyle的插件，还有很多其他的插件，用了一个，其他都差不多,还有一个PMD的插件，
一直重来没有注重代码规范，所以这里我开始注意
第一步：安装CheckStyle插件
? ?
? ?
出现如下窗口之后，选择ADD
? ?
? ?
之后，Namd的名称一般都是插件名称，路径为下载路径
直接update，
添加更新源地址：http://eclipse-cs.sf.net/update/，
也可以从http://sourceforge.net/projects/eclipse-cs/files/ 下载最新的插件包本地进行安装
我使用的在线安装方式，另外的安装方式我失败了！
? ?
? ?
如果第一个路径不好使，那么请使用第二个路径，出现如下结果，选中全选即可
? ?
? ?
继续进行安装
? ?
? ?
? ?
? ?
? ?
中间过程出现了以下提示框，点击OK，继续啊！
安装完毕之后，需要重启STS IDE
? ?
? ?
验证是否成功，可以对项目进行实时验证，但是我一般不太推荐！呵呵！
? ?
? ?
? ?
/************************关于常见的代码质量修改*************************************/
? ?
1.Line contains a tab character行含有"tab" 字符。
快速解决方法：可以使用editplus中的format功能，把tab字符转化为空格，然后保存Editplus英文版安装文件在我机子上有。
抱歉我不喜欢这种方式，我还是在我的Eclipse中修改模版方式，下面的截图来自于网络:
1.点击 window->preference-,依次选择 General->Editors->Text Editors,选中右侧的?insert space for tabs;如下图所示，保存，第一步完成；
2.点击 window->preference-,依次选择 java（或C++）->code style ->formatter,点击右侧的editor，选则左侧 tab policy的值为spaces only,确定，应用保存即可，如下图所示：
? ?
若出现应用Apply按钮为灰色的情况，需要回到上一步，点击new按钮，根据当前的样式重新生成一个新的样式并保存，重复第2步，编辑该样式即可，如下图：
? ?
? ?
? ?
但是针对XML,还需要修改tab键编程4个空格，修改如下
? ?
? ?
- Methos is missing a javadoc comment?方法前面缺少javadoc注释。解决方法：添加javadoc注释 类似这样：
/** * 初始化Servlet API * @param request * @param response */ |
? ?
? ?
3.4 checkstyle常见提示速查
???????? Checkstyle常见错误和警告提示见下表所示：
错误提示 | 错误说明 |
missing a javadoc comment | 缺少类注释 |
Line longer than X characters | 行长度超过X个字符(包括空格) |
Return count is X(max allowed 3) | 一个方法内的返回数量是X(最大值只能为3) |
Nested if-else depth is X(max allowed is 3) | 最大的if-else嵌套层数为X(最大只能为3) |
Array brackets at illegal position | 数组的方括号"[]"的位置不正确（检查数组类型的定义是String[] args，而不是String args[]） |
Line matchs the illegal pattern ‘System\.out\.println‘ | 本行包含System.out.println语句 |
ctor def modifier at indentation level 8 not at corrent indentation 4 | 缩进不正确，一般是因为没有在Eclipse中使用4个空格代替tab键引起。 |
‘static‘ modifier out of order with the JLS suggestions | static修饰符没有按照JLS的建议来排序(eg.写成public final static...应该改成public static final) |
Name ‘X‘ must match pattern ‘^[A-Z][A-Z0-9][_A-Z0-9+]$‘(正则表达式) | 名称不符合正则表达式‘^[A-Z][A-Z0-9][_A-Z0-9+]$‘(即为大写字母，数字、下划线等)。 一般在静态变量没有大写时提示，包名不是全部消息时提示，类名不是大写开头时提示，方法名不是小写开头时提示 |
Variable access definition in wrong order | 变量定义顺序不正确(例如在类成员变量定义时，将private类型的变量定义在public类型的变量之前) |
Static variable definition in wrong order | 静态变量定义顺序不正确(例如在构造函数之后定义静态变量) |
Instance variable definition in wrong order | 成员变量定义顺序不正确(例如在构造函数之后定义成员变量) |
X is a magic number | X是一个魔术数字(非0、1、2的数字) |
if construct must use ‘{}‘ | if结构必须使用‘{}‘ |
Got an exception - Unexpected character 0xfffd in identifier | 因为没有设置checkstyle配置文件的charset为UTF-8，而类文件使用UTF-8编码，并且含有中文 |
"{"?should be on the previous line | "{"?应该位于前一行 |
Methods 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?"X"?missing javadoc | 变量"CA"缺少javadoc注释 |
Line contains a tab character | 行含有"tab"?字符 |
Redundant?"Public"?modifier | 冗余的"public"?modifier |
final modifier out of order with the JSL suggestion | final修饰符的顺序错误 |
Avoid using the?".*"?form of import | Import格式避免使用".*" |
Redundant import from the same package | 从同一个包中Import内容 |
Unused import-X?Import | import的X类没有被使用 |
Duplicate import to line X | 重复Import同一个内容 |
Import from illegal package | 从非法包中?Import内容 |
"while"?construct must use?"{}" | "while"?语句缺少"{}" |
Variable?"X"?must be private and have accessor method | 变量"X"应该是private的，并且有调用它的方法 |
Variable?"X"?must match pattern"^[a-z][a-zA-Z0-9]*$" | 变量"X"不符合命名规则"^[a-z][a-zA-Z0-9]*$" |
"("?is followed by whitespace | "("?后面不能有空格 |
")"?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 followed by whitespace"(" 后面不能有空格 25")"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 (NumberFormatException nfe) {
LOG.error("Auto Renews the agreement failed", nfe);//异常捕捉里面不能为空，在异常里面加一句话。如打印等等
30?‘>‘ is not followed by whitespace.并且又有 ‘(‘ is preceded with whitespace.
定义集合和枚举的时候的时候，最后一个">"后面要有空格，"（"前面不容许有空格。解决方法：去掉泛型
31?Got an exception - java.lang.RuntimeException: Unable to get class information for @throws tag ‘SystemException‘.原因：不合理的throws。
解决方法：要确保某些类型，如某些类、接口不被throws。把声明的异常去掉。在实现类中抛出异常
网上参考解决方法：1、这是CheckStyle报的错。通常需要Refreh, clean/build这个Project. 如果不行，可以尝试clean all projects, restart Eclipse.
2、因为编译好的类没有在checkstyle的classpath中.所以, 只要将编译好的class配置到在的classpath中就没有这个问题了.另外, 还发现checkstyle的line length好像也有点问题, 明明没有超过120个字符, 却还是报错.无奈, 我把Eclipse中java > code style > formatter中的Maximum line with改成了100, 然后format一下, 基本就没有问题了
32?File does not end with a newline.解决方法：删掉报错的类，新建一个同名的类，把代码全部复制过去
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.
public class Foo
{
??? private int bar;
??? public Foo(int bar)
??? {
??????? this.bar = bar;
??? }
??? public final int getBar()
??? {
??????? return bar;
??? }
}
全局private int bar;和局部public Foo(int bar)的bar变量名字重复。
解决方法：把方法里面的参数名称改变下就可以了public Foo(int newBar)
??? {
??????? this.bar = newBar;
??? }。
36?Got an exception - Unexpected character 0xfffd in identifier
这是因为CheckStyle不能识别制定的编码格式。
网上参考解决方法：
1、Eclipse中可以配置，在Other-->checker中可以指定
2、可以修改checkstyle配置文件：
如果是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
以上是关于第01篇 提高代码质量插件的主要内容，如果未能解决你的问题，请参考以下文章