checkstyle配置文件说明.doc

属性说明 basedir代码所在的位置 AbstractClassNameformat: 定义抽象类的命名规则 PackageNameformat: 定义包名的命名规则 TypeNameformat: 定义类和接口的命名规则tokens: 定义规则适用的类型，例如：CLASS_DEF表示类，INTERFACE_DEF 表示接口 ParameterNameformat: 定义参数名的命名规则 ParameterNumbermax: 定义最多有多少个参数tokens: 定义检查的类型 StaticVariableNameformat: 定义静态变量的命名规则 MethodNameformat: 定义方法名的命名规则 LeftCurlyoption: 定义左大括号{显示位置，eol在同一行显示，nl在下一行显示maxLineLength: 大括号{所在行行最多容纳的字符数tokens: 该属性适用的类型，例：CLASS_DEF,INTERFACE_DEF,METHOD_DEF,CTOR_DEF LineLengthmax: 定义一行所能容许的字符数ignorePattern: 定义可以忽略的格式 MethodLength检查方法的行数max: 最多容许的行数countEmpty: 是否计算空行tokens: 定义检查的类型 RightCurlyoption: 右大括号是否单独一行显示tokens: 定义检查的类型 PackageHtml检查对每一个包是否生成了package.html文件fileExtensions: 指定要检查的文件的类型，如果只包含java文件，就不必指定 JavadocType检查类或者接口的javadoc注释authorFormat: 检查author标签的格式versionFormat: 检查version标签的格式scope: 可以检查的类的范围，例如：public只能检查public修饰的类，private可以检查所有的类excludeScope: 不能检查的类的范围，例如：public，public的类将不被检查，但访问权限小于public的类仍然会检查，其他的权限以此类推tokens: 该属性适用的类型，例如：CLASS_DEF,INTERFACE_DEF JavadocMethod检查方法的javadoc的注释scope: 可以检查的方法的范围，例如：public只能检查public修饰的方法，private可以检查所有的方法allowMissingParamTags: 是否忽略对参数注释的检查allowMissingThrowsTags: 是否忽略对throws注释的检查allowMissingReturnTag: 是否忽略对return注释的检查 JavadocVariable检查类变量的注释scope: 检查变量的范围，例如：public只能检查public修饰的变量，private可以检查所有的变量 JavadocStylescope: excludeScope: checkFirstSentence: checkEmptyJavadoc: checkHtml: tokens: LocalVariableNameformat: 定义局部变量的命名规则 LocalFinalVariableNameformat: 定义局部常量的命名规则 ConstantNameformat: 定义全局常量的命名规则 MemberNameformat: 定义非静态成员变量的命名规则applyToPublic: 是否适用于public的成员变量applyToProtected: 是否适用于protected的成员变量applyToPackage: 是否适用于package的成员变量applyToPrivate: 是否适用于private的成员变量 AvoidStarImport必须导入类的完整路径，即不能使用*导入所需的类excludes: 定义可以使用*导入的包 ImportOrder定义导入包的顺序groups: 定义导入包的顺序，默认以字母顺序导入ordered: 定义包是否必须按规定的顺序显示separated: 定义包与包之间是否应添加空白行caseSensitive: 是否区分包名的大小写 IllegalImport检查是否从非法的包中导入了类illegalPkgs: 定义非法的包名称 UnusedImports检查是否导入的包没有使用 RedundantImport检查是否导入了不必显示导入的类 EmptyForInitia