CheckStyle使用说明.doc

CheckStyle使用说明1、概要 在目前的开发过程中，我们对编码的检查集中在项目即将结束时的“代码复查”阶段。这个时候对代码进行复查，由于编码接近收尾，代码数量庞大，检查任务繁重，根本不可能按照部门的编码标准来格式化代码。所以我们需要一个工具来对代码进行检查。但是，即使是有了这样的工具，如果在“代码复查”阶段才对代码格式进行检查。仍然难以达到要求的标准。所以我们希望将代码复查的工作融合在编码过程中。这样一方面可以达到“代码复查”的目的；一方面有助于提高程序员的编码质量意识，形成良好的编码习惯。Checkstyle可以帮助我们达到这个目标。 2、CheckStyle的安装说明 下载地址：/ CheckStyle插件的安装很简单，在这里我们介绍两种安装方法。方法一：通过更新网页1 在Eclipse中，选择Help-Software Updates-Find and Install2.选择 Search for new features to install 选择Next3.选择 New Remote Site4.在名称中输入 Checkstyle Plug-in，在URL中输入：/update5.然后继续安装就行了。方法二：你可以自己从Eclipse Checkstyle Plug-ins SourceForge project page下载安装包最新版。下载地址：/ 下载到之后，把里面的两个文件夹plugins和 features下面的文件分别放到eclipse 目录下面对应的plugins和features目录下。3、CheckStyle的配置说明 CheckStyle有两种使用方式，一种是通过ant来运行的方式；一种是利用插件的使用方式。这里我们介绍插件的使用方式。 首先通过菜单windowpreferences进入CheckStyle的配置项点击上面菜单后，弹出如下的配置对话框（图2）然后我们点击“NEW”按钮弹出如下的对话框，并且在对话框上选择导入外部配置文件，然后点击browse按钮将部门的style配置文件引入，作为我们检查代码的标准。（图3）（图4）这样我们就做好了对checkstyle的格式配置。 下面我们介绍一下关于图 2中的其他几个重要按钮的介绍：Properties: 该按钮实现对现有的检查标准名称的修改和对检查文件的关联地址。如下图示：Configure: 该按钮实现对检查标准项的配置：如下图示Copy: 该按钮实现通过当前已有的代码检查标准生成一个同样的副本。4、CheckStyle的使用说明： 首先选择一个工程属性：如下图示然后选择上图左边树上的checkstyle项，出现如上图右边的显示；选择下拉列表中的”javastyle”项。我们就可以使用checkstyle来检查代码了。另外，如果是在编码过程中，编译文件时候检查自己的代码的话。将上图中右边的“Exclude from checking”栏中的多选框都选中即可。如果是PM想检查所有的源文件的话，将第二项去掉即可。如下图所示的检查结果：其中problems显示出了有问题的代码部分，并且在源代码中作出了标识。我可以根据相关的问题描述做出相应的修改操作。5、Checkstyle的输出说明序号输出内容意义1Type is missing a javadoc commentClass 缺少类型说明2“” should be on the previous line “” 应该位于前一行3Methos is missing a javadoc comment方法前面缺少javadoc注释4Expected 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“” 应该与下条语句位于同一行10Unused param tag for “unused”没有参数“unused”，不需注释11Variable “CA” missing javadoc变量“CA”缺少javadoc注释12Line longer than 80characters行长度超过8013Line contains a tab character行含有”tab” 字符14Redundant “Public” modifier冗余的“public” modifier15Final modifier out of order with the JSL suggestionFinal modifier的顺序错误16Avoid using the “.*” form of importImport格式避免使用“.*”17Redundant import from the same package从同一个包中Import内容18Unused import-java.util.listImport进来的java.util.list没有被使用19Duplicate import to line 13重复Import同一个内容20Import from illegal package从非法包中 Import内容21“while” construct must use “”“while” 语句缺少“”22Variable “sTest1” must be private and have accessor method变量“sTest1”应该是private的，并且有调用它的方法23Variable “ABC” must match patt