代碼格式化的好處我想我就不需要說了,大家肯定也都理解其優點,否則你也不會看這個文檔.
　　
　　這里我以CheckStyle3.4為例,講解CheckStyle的使用,確切的說是其配置的具體解釋,假如你是Checkstyle3.4以下,那么有一部分module將是不可以答應的,請刪除之;在這份文檔中我試圖把所有的module都分析講解一次,同時下面的這份文檔也是我的設置,對于我個人不喜歡的設置我都注釋了,假如你需要請取消注釋或如何!!
　　
　　Checkstyle簡介,其是目前最廣泛使用的代碼檢查工具,功能強大,操作簡單可以和Ant結合使用,最重要的是其是Open Source的,你不用擔心收到律師函,哈哈!
　　
　　主頁: http://checkstyle.sourceforge.net/
　　
　　下載本文示例: 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="checkstyletask.properties" classpathref=" checkstyle-all-3.4.jar"/>
　　<target name="checkstyle_check" depends="init">
　　<checkstyle config="${checkstyle.config}" failOnViolation="false" failureProperty="checkstyle.failure">
　　<formatter 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"
　　"http://www.puppycrawl.com/dtds/configuration_1_2.dtd">
　　<!-- 對于所有的模塊來書,假如有這個模塊則說明檢測這一項,沒有則不檢測這一項 -->
　　<!-- 所有的模塊中,其ROOT必須為Checker -->
　　<module name="Checker">
　　<!-- 檢驗每個包是否存在package.html文件-->
　　<!-- See http://checkstyle.sf.net/config_javadoc.html#PackageHtml -->
　　<!--
　　<module name="PackageHtml"/>
　　-->
　　<!-- 檢驗每個文件末尾是否有一個空行,在UNIT機器上是有的,在CVS上假如沒有會有警告的-->
　　<!-- See http://checkstyle.sf.net/config_misc.html#NewlineAtEndOfFile -->
　　<!--
　　<module name="NewlineAtEndOfFile"/>
　　-->
　　<!-- Checks that property files contain the same keys. -->
　　<!-- See http://checkstyle.sf.net/config_misc.html#Translation -->
　　<module name="Translation"/>
　　<module name="TreeWalker">
　　<!-- Checks for Javadoc comments. -->
　　<!-- See http://checkstyle.sf.net/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="checkFirstSentence" value="false"/>
　　<!-- 檢查錯誤的HTML腳本,比如不匹配,true檢查,default為true -->
　　<property name="checkHtml" value="true"/>
　　</module>
　　<!-- Checks for Naming Conventions. -->
　　<!-- See http://checkstyle.sf.net/config_naming.html -->
　　<!-- 確省必須以Abstract開始或者以Factory結束 -->
　　<!--
　　<module name="AbstractClassName"/>
　　-->
　　<module name="ConstantName"/>
　　<module name="LocalFinalVariableName"/>
　　<module name="LocalVariableName"/>
　　<module name="MemberName"/>
　　<module name="MethodName"/>
　　<module name="PackageName"/>
　　<module name="ParameterName"/>
　　<module name="StaticVariableName"/>
　　<module name="TypeName"/>
　　<!-- Checks for Headers -->
　　<!-- See http://checkstyle.sf.net/config_header.html -->
　　<!-- 檢查文件是否以指定文件開始,這里最好是放一些版權信息和工程描述 -->
　　<!-- headerFile:指定的文件 -->
　　<!-- ignoreLines:忽略哪些行,以","分隔 -->
　　<!--
　　<module name="Header">
　　<property name="headerFile" value="java.header"/>
　　<property name="ignoreLines" value="2, 3, 4, 5"/>
　　</module>
　　-->
　　<!-- Following interprets the header file as regular eXPressions. -->
　　<!--
　　<module name="RegexpHeader"/>
　　-->
　　<!-- Checks for imports -->
　　<!-- See http://checkstyle.sf.net/config_import.html -->
　　<!-- 檢查使用*號的導入,默認為全部類 -->
　　<module name="AvoidStarImport"/>
　　<!-- 檢查是否有非法的包,確省檢查sun.*;對于某些包是不建議直接調用的 -->
　　<module name="IllegalImport">
　　<property name="illegalPkgs" value="sun.*"/>
　　</module>
　　<!-- 檢查多于的導入,如一個類導入了多次 -->
　　<module name="RedundantImport"/>
　　<!-- 檢查沒有使用的導入 -->
　　<module name="UnusedImports"/>
　　<!-- 導入排序 -->
　　<!-- groups:分組,哪些是一組的 -->
　　<!-- ordered:同一個組內是否排序,true排序,確省為true -->
　　<!-- separated:各個組之間是否需要用空行分隔,確省為false -->
　　<!-- caseSensitive:是否是大小寫敏感的,確省是 -->
　　<!--
　　<module name="ImportOrder">
　　<property name="groups" value="java,javax"/>
　　<property name="ordered" value="true"/>
　　<property name="separated" value="true"/>
　　<property name="caseSensitive" value="true"/>
　　</module>
　　-->
　　<!-- Checks for Size Violations. -->
　　<!-- See http://checkstyle.sf.net/config_sizes.html -->
　　<!-- 檢查方法內可執行語句的個數,確省為30行 -->
　　<!--
　　<module name="ExecutableStatementCount">
　　<property name="max" value="30"/>
　　</module>
　　-->
　　<!-- 文件的最大行數,缺省為1500 -->
　　<module name="FileLength">
　　<property name="max" value="2000"/>
　　</module>
　　<!-- 每行的最大字符數,缺省為80 -->
　　<module name="LineLength">
　　<!-- 忽略指定格式的行,如*號開始的,等 -->
　　<!--
　　<property name="ignorePattern" value="^ *\* *[^ ]+$"/>
　　-->
　　<property name="max" value="120"/>
　　</module>
　　<!-- 方法的最大行數,缺省為150 -->
　　<module name="MethodLength">
　　<property name="max" value="200"/>
　　<!-- 統計時是否包括空行和以//開始的注釋,缺省為統計(true)-->
　　<property name="countEmpty" value="false"/>
　　</module>
　　<!-- 匿名類的最大行數,缺省為20 -->
　　<module name="AnonInnerLength">
　　<property name="max" value="60"/>
　　</module>
　　<!-- 檢查方法和構造子參數的最大個數,缺省為7 -->
　　<module name="ParameterN
關注此文的讀者還看過：
·2013-8-13 8:55:48 使用Java將Word轉為Html或txt!
·2013-8-13 8:55:48 精通Hibernate之映射繼承關系七(圖)
·2013-8-13 8:55:47 根據name調用getName方法
·2013-8-13 8:55:46 Java GUI誤解 因為外觀而拒絕Swing？
·2013-8-13 8:55:38 Java的字符串操作
·2013-8-13 8:55:36 Java的文件與磁盤操作
?

資料引用:http://www.knowsky.com/367856.html

總結

以上是生活随笔為你收集整理的CheckStyle及其配置的详细解释的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。