CheckStyle 及其配置的詳細(xì)解釋

2019-11-18 11:55:16

字體：大中小

供稿：網(wǎng)友

代碼格式化的好處我想我就不需要說(shuō)了,大家肯定也都理解其優(yōu)點(diǎn),否則你也不會(huì)看這個(gè)文檔.
　　
　　這里我以CheckStyle3.4為例,講解CheckStyle的使用,確切的說(shuō)是其配置的具體解釋,假如你是Checkstyle3.4以下,那么有一部分module將是不可以答應(yīng)的,請(qǐng)刪除之;在這份文檔中我試圖把所有的module都分析講解一次,同時(shí)下面的這份文檔也是我的設(shè)置,對(duì)于我個(gè)人不喜歡的設(shè)置我都注釋了,假如你需要請(qǐng)取消注釋或如何!!
　　
　　Checkstyle簡(jiǎn)介,其是目前最廣泛使用的代碼檢查工具,功能強(qiáng)大,操作簡(jiǎn)單可以和Ant結(jié)合使用,最重要的是其是Open Source的,你不用擔(dān)心收到律師函,哈哈!
　　
　　主頁(yè): http://checkstyle.sourceforge.net/
　　
　　下載本文示例: olics_checkstyle_checks.zip
　　
　　開(kāi)始我們的講解:
　　首先,Checkstyle可以和Ant結(jié)合使用,下面是Ant腳步片斷
　　
　　<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>
　　<!—生成報(bào)告,其格式取決于${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">
　　
　　
　　<module name="Checker">
　　
　　
　　
　　
　　
　　
　　
　　
　　<module name="Translation"/>
　　<module name="TreeWalker">
　　
　　
　　
　　<module name="JavadocMethod">
　　<property name="scope" value="public"/>
　　
　　<property name="allowMissingParamTags" value="true"/>
　　
　　<property name="allowMissingThrowsTags" value="true"/>
　　
　　<property name="allowMissingReturnTag" value="true"/>
　　</module>
　　
　　<module name="JavadocType"/>
　　
　　<module name="JavadocVariable">
　　<property name="scope" value="protected"/>
　　</module>
　　
　　<module name="JavadocStyle">
　　<property name="scope" value="public"/>
　　
　　<property name="checkFirstSentence" value="false"/>
　　
　　<property name="checkHtml" value="true"/>
　　</module>
　　
　　
　　
　　
　　<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"/>
　　
　　
　　
　　
　　
　　
　　
　　
　　
　　
　　
　　<module name="AvoidStarImport"/>
　　
　　<module name="IllegalImport">
　　<property name="illegalPkgs" value="sun.*"/>
　　</module>
　　
　　<module name="RedundantImport"/>
　　
　　<module name="UnusedImports"/>
　　
　　
　　
　　
　　
　　
　　
　　
　　
　　
　　
　　<module name="FileLength">
　　<property name="max" value="2000"/>
　　</module>
　　
　　<module name="LineLength">
　　
　　
　　<property name="max" value="120"/>
　　</module>
　　
　　<module name="MethodLength">
　　<property name="max" value="200"/>
　　
　　<property name="countEmpty" value="false"/>
　　</module>
　　
　　<module name="AnonInnerLength">
　　<property name="max" value="60"/>
　　</module>
　　
　　<module name="ParameterN

上一篇：Java 學(xué)習(xí)之了解 Java 的運(yùn)行環(huán)境

下一篇：簡(jiǎn)單的網(wǎng)頁(yè)關(guān)鍵詞匹配工具