CheckStyle 使用说明


软件开发事业部 编码改善文档 CheckStyle 使用说明 目的 本文是基于 eclipse Version: 3.1.0 和 checkstyle_4.0.0 概要 在目前的开发过程中,我们对编码的检查集中在项目即将结束时的“代码复 查”阶段。这个时候对代码进行复查,由于编码接近收尾,代码数量庞大,检查 任务繁重,根本不可能按照部门的编码标准来格式化代码。所以我们需要一个工 具来对代码进行检查。但是,即使是有了这样的工具,如果在“代码复查”阶段 才对代码格式进行检查。仍然难以达到要求的标准。所以我们希望将代码复查的 工作融合在编码过程中。这样一方面可以达到“代码复查”的目的;一方面有助 于提高程序员的编码质量意识,形成良好的编码习惯。Checkstyle 可以帮助我们 达到这个目标。 CheckStyle 使用说明 CheckStyle 的安装 下载地址:http://eclipse-cs.sourceforge.net/ CheckStyle 有两种使用方式,一种是通过 ant 来运行的方式;一种是利用插件 的使用方式。这里我们介绍插件的使用方式。 CheckStyle插件的安装很简单,将插件的文件夹复制到 eclipse 的 plugins 目录 下。启动 eclipse 即可。 CheckStyle 的配置说明 首先通过菜单 window—〉preferences 进入 CheckStyle 的配置项 软件开发事业部 编码改善文档 (图 1) 点击上面菜单后,弹出如下的配置对话框 (图 2) 软件开发事业部 编码改善文档 然后我们点击“NEW”按钮弹出如下的对话框,并且在对话框上选择导入 外部配置文件,然后点击 browse 按钮将部门的 style 配置文件引入,作为我们检 查代码的标准。 (图 3) (图 4) 这样我们就做好了对 checkstyle 的格式配置。 下面我们介绍一下关于图 2中的其他几个重要按钮的介绍: Properties: 软件开发事业部 编码改善文档 该按钮实现对现有的检查标准名称的修改和对检查文件的关联地址。如下 图示: (图 5) Configure: 该按钮实现对检查标准项的配置:如下图示 (图 6) 软件开发事业部 编码改善文档 Copy: 该按钮实现通过当前已有的代码检查标准生成一个同样的副本。 CheckStyle 的使用: 首先选择一个工程属性:如下图示 (图 7) 软件开发事业部 编码改善文档 (图 8) 然后选择上图左边树上的 checkstyle 项,出现如上图右边的显示;选择下拉列表 中的”javastyle”项。我们就可以使用 checkstyle 来检查代码了。 另外 ,如果是在编码过程中,编译文件时候检查自己的代码的话。将上图 中右边的“Exclude from checking”栏中的多选框都选中即可。如果是 PM 想检 查所有的源文件的话,将第二项去掉即可。 如下图所示的检查结果 软件开发事业部 编码改善文档 其中 problems 显示出了有问题的代码部分,并且在源代码中作出了标识。 我可以根据相关的问题描述做出相应的修改操作。 更详细的配置介绍可以通过“参考资料“获得 参考资料: http://eclipse-cs.sourceforge.net/
还剩6页未读

继续阅读

下载pdf到电脑,查找使用更方便

pdf的实际排版效果,会与网站的显示效果略有不同!!

需要 7 金币 [ 分享pdf获得金币 ] 0 人已下载

下载pdf

pdf贡献者

aw2008

贡献于2013-02-23

下载需要 7 金币 [金币充值 ]
亲,您也可以通过 分享原创pdf 来获得金币奖励!
下载pdf