Eclipse的插件checkStyle结果分析.doc

Eclipse的插件checkStyle结果分析 安装checkStyle插件以及配置 安装：直接update，添加更新源地址：/update/，也可以从/projects/eclipse-cs/files/ 下载最新的插件包本地进行安装。 配置：默认安装有2个检查的配置文件，如下图，Type为Build-In的是默认的，可以自己按照内置的Copy一个出来后进行修改，或者Import已经存在的检查xml配置文件。 配合着使用的还有一个Codestyle，如下图，设计到有Clean up、Template、Formatter等几个选项，默认的Eclopse 提供的Clean up好像什么事情都没做，所以最好是自己新建一个或者是导入一个。 常见提示解释 1、Type is missing a javadoc commentClass 缺少类型说明 2、“{” should be on the previous line“{” 应该位于前一行。解决方法：把“{”放到上一行去 3、Methos 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“}” 应该与下条语句位于同一行。解决方法：把“}”放到下一行的前面 10、Unused @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内容