Eclipse中checkStyle的使用.docVIP

1、安装Checkstyle的Eclipse的插件 1)???添加更新源地址 /update/ ?直接update 2)????从 /projects/eclipse-cs/files/ 下载最新的插件包本地进行安装 2、在Eclipse中使用Checkstyle 1)???? 插件安装成功后，在Eclipse中点击Window-Preferences选项可以看到下图 ? 2)????新增远程配置文件 3)????右键单击项目，选择Properties-Checkstyle后可以看到下图 A)??????? 选中Check Box－Checkstyle active for this project B)??????? 从下拉列表中选择一个Checkstyle的配置文件 C)??????? 点击OK ? 3)????查看Checkstyle violations视图，可以看到Checkstyle检测汇总结果 双击其中一项，可以看到该问题出现明细列表 双击其中一项，可以看到问题出现的位置，可以看到类似下图的情况： 将鼠标指向图中的放大镜处稍做停留便可看到提示信息，如图片中的”Missing a Javadoc comment.” ? 3、Checkstyle配置文件的简要说明 关于配置文件的各个模块的更多细节，请参考CHECKSTYLE_HOME/docs/index.html ? ?xml version=1.0 encoding=UTF-8? !DOCTYPE module PUBLIC -//Puppy Crawl//DTD Check Configuration 1.2//EN /dtds/configuration_1_2.dtd !-- 对于所有的模块来书,如果有这个模块则说明检测这一项,没有则不检测这一项 -- !-- 所有的模块中,其ROOT必须为Checker -- module name=Checker !-- 检验每个包是否存在package.html文件-- !-- See /config_javadoc.html#PackageHtml -- !-- module name=PackageHtml/ -- !-- 检验每个文件末尾是否有一个空行-- !-- See /config_misc.html#NewlineAtEndOfFile -- !-- module name=NewlineAtEndOfFile/ -- !-- Checks that property files contain the same keys. -- !-- See /config_misc.html#Translation -- module name=Translation/ module name=TreeWalker !-- Checks for Javadoc comments. -- !-- See /config_javadoc.html -- !-- Checks Javadoc comments for method definitions.-- module name=JavadocMethod property name=scope value=public/ !-- 是否允许错误的参数声明,true为允许,缺省为不允许 -- property name=allowMissingParamTags value=true/ !-- 是否允许错误的错误声明,true为允许,缺省为不允许 -- property name=allowMissingThrowsTags value=true/ !-- 是否允许错误的返回类型声明,true为允许,缺省为不允许 -- property name=allowMissingReturnTag value=true/ /module !--Checks Javadoc comments for class and interface definitions.-- module name=JavadocType/ !-- Checks that variables have Javadoc comments.-- module name=JavadocVariable property name=scope value=protected/ /module !-- 检查Javadoc的格式 -- module name=JavadocStyle property name=scope value=public/ !-- Comment的第一句的末尾是否要有一个句号,true必须有,default为true -- property name=checkFirstSent