CheckStyle 及其配置的详细解释

代码格式化的好处我想我就不需要说了,大家肯定也都理解其优点,否则你也不会看这个文档.
　　
　　这里我以CheckStyle3.4为例,讲解CheckStyle的使用,确切的说是其配置的具体解释,假如你是Checkstyle3.4以下,那么有一部分module将是不可以答应的,请删除之;在这份文档中我试图把所有的module都分析讲解一次,同时下面的这份文档也是我的设置,对于我个人不喜欢的设置我都注释了,假如你需要请取消注释或如何!!
　　
　　Checkstyle简介,其是目前最广泛使用的代码检查工具,功能强大,操作简单可以和Ant结合使用,最重要的是其是Open Source的,你不用担心收到律师函,哈哈!
　　
　　主页: http://checkstyle.sourceforge.net/
　　
　　下载本文示例: olics_checkstyle_checks.zip
　　
　　开始我们的讲解:
　　首先,Checkstyle可以和Ant结合使用,下面是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>
　　<!—生成报告,其格式取决于${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