Checkstyle详细配置.docx

Checkstyle的配置详解 Checkstyle是一款检查java程序代码样式的工具，可以有效的帮助我们检视代码以便更好的遵循代码编写标准，特别适用于小组开发时彼此间的样式规范和统一。Checkstyle提供了高可配置性，以便适用于各种代码规范，所以除了可以使用它提供的sun的代码标准外，你也可以定制自己的标准。我们可以在eclipse中安装checkstyle的插件，来方便我们的使用。 Checkstyle可以让我们养成书写良好代码风格的习惯，代码的整洁也减少了很多bad smell的产生。使用checkstyle的过程中可能需要经常的调整配置文件，有些check过于严格，可以根据实际情况取消一些代码检查。Checkstyle的配置Checkstyle配置是通过指定modules来应用到java文件的。modules是树状结构，以一个名为Checker的module作为root节点，一般的checker都会包括TreeWalker子module。我们可以参照checkstyle中的sun_checks.xml，这是根据sun的java语言规范写的配置。在xml配置文件中通过module的name属性来区分module，module的Properties可以控制如何去执行这个module，每个property都有一个默认值，所有的check都有一个severity属性，用它来指定check的level。TreeWalker为每个java文件创建一个语法树，在节点之间调用submodules的Checks。下面来看看standard checks中的一些具体用法。Javadoc Comments? JavadocPackage检查每个java package中是否有java注释文件，默认是允许一个package-info.java，也可以通过allowLegacy属性配置允许package.html。? JavadocType检查类和接口的javadoc。默认不检查author 和version tags。? JavadocMethod检查方法和构造函数的javadoc。默认不检查未使用的异常抛出。? JavadocVariable检查变量的javadoc。? JavadocStyle检查javadoc的格式。比如：javadoc的第一行是否以句号结束，javadoc除了tags外是否有description，检查javadoc中的html格式。? WriteTag输出javadoc中的tag。Naming Conventions? AbstractClassName检查抽象类名。? ClassTypeParameterName检查类的Parameter名。? ConstantName检查常量名。? LocalFinalVariableName检查局部的final类型变量名，包括catch的参数。? LocalVarableName检查局部的非final类型的变量名，包括catch的参数。? MemberName检查非静态变量。? MethodName检查方法名。? MethodTypeParameterName检查方法的参数名。? PackageName检查包名。? ParameterName检查参数名。? StaticVariableName检查静态的，非final类型的变量名。? TypeName检查类名和接口名。Imports? AvoidStarImport检查是否有使用*进行import。? AvoidStaticImport检查是否有静态import。比如是否导入了java.lang包中的内容。? IllegalImport检查是否import了违法的包。默认拒绝import所有sun.*包。? RedundanImport检查是否有重复的import。? UnusedImports检查是否有未使用的import。? ImportOrder检查import的分组和顺序。? ImportControl控制可import的包。在一个较大的project可限制使用过多的第三方包，通过一个依照/dtds/import_control_1_0.dtd的xml文件来指定。Size Violations? Execut