CheckStyle使用详解.doc

代码格式化的好处我想我就不需要说了,大家肯定也都理解其优点,否则你也不会看这个文档.????这里我以CheckStyle3.4为例,讲解CheckStyle的使用,确切的说是其配置的详细解释,如果你是Checkstyle3.4以下,那么有一部分module将是不可以允许的,请删除之;在这份文档中我试图把所有的module都分析讲解一次,同时下面的这份文档也是我的设置,对于我个人不喜欢的设置我都注释了,如果你需要请取消注释或如何!!????Checkstyle简介,其是目前最广泛使用的代码检查工具,功能强大,操作简单可以和Ant结合使用,最重要的是其是Open Source的,你不用担心收到律师函,哈哈!????主页:? HYPERLINK / /????下载本文示例:? HYPERLINK file:///d:\\olics_checkstyle_checks.zip olics_checkstyle_checks.zip开始我们的讲解:首先,Checkstyle可以和Ant结合使用,下面是Ant脚步片断!--CheckStyle配置,这里你替换成你实际的环境--property name=checkstyle.config value=${project.docs.dir}/checkstyle_checks.xml/property name=checkstyle.report.style value=${project.docs.dir}/checkstyle-frames.xsl/property name=checkstyle.result value=${build.checkstyleReport.dir}/checkstyle_result.xml/property name=checkstyle.report value=${build.checkstyleReport.dir}/checkstyle_report.html/!—CheckStyle脚步--taskdef resource=perties classpathref= checkstyle-all-3.4.jar/target name=checkstyle_check depends=initcheckstyle config=${checkstyle.config} failOnViolation=false failureProperty=checkstyle.failureformatter type=xml tofile=${checkstyle.result}/fileset dir=${project.src.dir} includes=**/*.java//checkstyle!—生成报告,其格式取决于${checkstyle.report.style}--style in=${checkstyle.result} out=${checkstyle.report} style=${checkstyle.report.style}//target下面是我理解的 Checkstyle 的使用 :?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/--!-- 检验每个文件末尾是否有一个空行,在UNIT机器上是有的,在CVS上如果没有会有警告的--!-- 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 /conf