eclipse中配置checkStyle和使用方法.docx

CheckStyle安装在Eclipse当中安装CheckStyle插件非常方便，和安装findBugs除了URL有区别之外，其他的几乎完全一样。我们可以参照以下几个步骤进行（注意一下，eclipse版本不一样，可能安装插件的位置有所调整，但是安装方法都是一样的，具体根据自己版本进行安装。）:1. 在Eclipse当中分别打开一下菜单 Help-install new software2. 在弹出窗口的第一行work with中输入插件地址，即：/update3. 输入之后稍微等一下，弹出窗口中间部分窗体中会在网上搜索上边输入地址的一些可用插件，并显示出来提供我们选择。我们选择checkStyle，点击下一步。点击下一步之后再出现的窗体中继续点击下一步：此时窗口中有一堆英文字母，下边出现俩单选按钮，是不是很像我们安装一些软件时出现的协议之类的东西，下边是我同意此协议，或者不同意此协议，很明显，不同意的话你就无法点击下一步了，默认就是不同意的，所以我们要把它选择成同意。选择了之后点击Finish就开始安装了。4. 开始安装安装过程中会有警告弹出，不管它，点击OK继续安装。5. 安装完毕之后弹出窗口提示要重启eclipse，点击yes就OK了。注：高版本的MyEclipse下安装插件有所区别，时间紧迫，文档没有整理出来，请参考：/s/blog_8f82e8280101ofwv.htmlCheckStyle的使用1. 重启之后随便在某个项目上点击鼠标右键，会发现右键菜单中多了一个CheckStyle的选项，这个就是我们刚才安装的插件。如何配置符合公司规范的CheckStyle规则文件安装完CheckStyle之后，检查代码时默认的检测规则其实和我们目前的规则有一些差异，并且初始为英文版，为了方便使用，我们需要修改一下规则文件，我们的规则文件我已经做了修改，全局中文提示。1. 首先下载我们自己的规则文件。sunrising_checks.xml2. 打开eclipse，在window选项中找到Preferences，点击打开的窗口中也会多出来一个CheckStyle，如图：3. 可以看到默认有两个规则文件提供选择，此时我们点击New，把我们自己的规则文件加进去。输入Name，然后点击Import按钮，把上边下载的规则文件选中，然后点击OK4. 点击OK之后会发现右侧的列表中多了一个规则文件，就是我们新添加的5. 然后选中我们新加的那行，在最右侧按钮区域点击Set as Default即可。此时我们能发现我们自己添加的规则文件行打上了对勾，这就说明我们自己配置的规则文件已经正式启用了。试一下效果如何！效果图：鼠标放到错误信息上会提示错误原因，上图的意思是方法参数名必须要通过后边的正则表达式验证。后边的正则是我根据公司规范些的，方法传参必须已小写a开头，第二个字母大写，不允许输入数字，最大长度为30。Eclipse插件CheckStyle安装以及使用(2008-10-05 00:26:05)转载标签： eclipseplug-inwithandfor分类： 技术分享 第一部分Checkstyle的使用介绍 Checkstyle是一个开发工具，可以帮助编程人员编写符合编码规范的java 代码。程序员都非常讨厌程序的check工作，checkstyle能够自动地完成这项烦琐但又非常重要的工作，从而节省了的程序员的时间，也提高了检查的质量。Checkstyle已经成了加强编码规范的首选工具。 NtCheckstyle 是一个可安装的模块，它自动完成Checkstyle和Netbeans 环境的集成。集成后checkstyle的使用非常的方便。安装你可以在Netbeans中直接安装NbCheckstyle。第二部分checkStyle安装方法一：通过更新网页1。在Eclipse中，选择Help-Software Updates-Find and Install2.选择Search for new features to install选择Next3.选择New Remote Site4.在名称中输入Checkstyle Plug-in，在URL中输入：/update5.然后继续安装就行了。方法二：1。你可以自己从Eclipse Checkstyle Plug-ins SourceForge project page下载安装包，最新版的（2007/4/2）为4.3.0。下载到之后，把里面的两个文件夹plugins和 features下面的文件分别放到eclipse 目录下面对应的plugins和features目录下。（别弄错了哦_)2。清千万注意了，如果你就这样直接启动eclipse 可能会出现ClassNotFoundExceptions 等错误。你必须在启动eclipse的时候加上一个参数 -clean. 这样eclipse就可以更新它当前安装的许多插件信息。比如你得eclipse在d盘 那么就是d:eclipseeclipse.exe-cleanImportant Note:As of plug-in release 4.0.0 only Eclipse 3.0 and newer is supported. Eclipse 2.x.x support is discontinued. Please use older plug-in versions with Eclipse 2.x.x. - downloadable from theSourceForge Project Page（不翻译了）安装完毕！第三部分 checkStyle 使用1.启动eclipse2. 打开你要检查的项目的属性3.在对话框中选择你要的checkStyle项目请注意不要忘记了在左上角那个box打勾。如图。4。接下来就可以看看你的代码符合规范与否了5。如果看到下图的效果小弟恭喜你了！安装成功了。第四部分Checkstyle的结果输出序号 输出内容意义1 Type is missing a javadoc commentClass 缺少类型说明2“” should be on the previous line “” 应该位于前一行3 Methos is missing a javadoc comment方法前面缺少javadoc注释4 Expected 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“” 应该与下条语句位于同一行10 Unused param tag for “unused”没有参数“unused”，不需注释11 Variable “CA” missing javadoc变量“CA”缺少javadoc注释12 Line longer than 80characters行长度超过8013 Line contains a tab character行含有”tab” 字符14 Redundant “Public” modifier冗余的“public” modifier15 Final modifier out of order with the JSL suggestionFinal 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