`

checkstyle配置

阅读更多
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.3//EN" "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">

<!--
    This configuration file was written by the eclipse-cs plugin configuration editor
-->
<!--
    Checkstyle-Configuration: check
    Description: none
-->
<module name="Checker">
  <property name="severity" value="error"/>
  <property name="charset" value="UTF-8"/>
  <message key="general.exception" value="有一个异常 - {0}"/>
  <message key="general.fileNotFound" value="文件没找到!"/>
  <module name="TreeWalker">
    <property name="severity" value="error"/>
    <property name="tabWidth" value="4"/>
    <message key="general.exception" value="有一个异常 - {0}"/>
    <module name="PackageName">
      <property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/>
      <message key="name.invalidPattern" value="包名 ''{0}'' 必须符合正则表达式 ''{1}''."/>
    </module>
    <module name="TypeName">
      <message key="name.invalidPattern" value="名称 ''{0}'' 必须符合正则表达式 ''{1}''."/>
    </module>
    <module name="MethodName">
      <property name="severity" value="warning"/>
      <property name="format" value="(^[a-z][a-zA-Z0-9]{0,14}$)"/>
      <message key="name.invalidPattern" value="名称 ''{0}''必须符合以下正则表达式 ''{1}''."/>
      <message key="method.name.equals.class.name" value="名称 ''{0}'' 不能与内部类名称相同."/>
    </module>
    <module name="MemberName">
      <message key="name.invalidPattern" value="名称 ''{0}'' 必须符合正则表达式 ''{1}''."/>
    </module>
    <module name="Indentation">
      <message key="indentation.error" value="{0} 代码缩进 {1} 不正确, {2}"/>
      <message key="indentation.child.error" value="{0} 子功能代码缩进 {1} 不正确, {2}"/>
    </module>
    <module name="RedundantThrows">
      <property name="severity" value="warning"/>
      <message key="redundant.throws.classInfo" value="没办法获得类信息 {0}."/>
      <message key="redundant.throws.duplicate" value="冗余的 throws: ''{0}'' 使用了多次."/>
      <message key="redundant.throws.subclass" value="冗余的 throws: ''{0}'' 是 ''{1}''的子类."/>
      <message key="redundant.throws.unchecked" value="冗余的 throws: ''{0}'' 是运行时的异常."/>
    </module>
    <module name="MultipleVariableDeclarations">
      <property name="severity" value="warning"/>
      <message key="multiple.variable.declarations.comma" value="每一个变量的定义必须在它的声明处,且在同一行."/>
      <message key="multiple.variable.declarations" value="每一行只能定义一个变量."/>
    </module>
    <module name="UpperEll">
      <message key="upperEll" value="必须使用大写字母 ''L''."/>
    </module>
    <module name="ArrayTypeStyle">
      <message key="array.type.style" value="数组中括号位置不对,建议如:String[] args."/>
    </module>
    <module name="ConstantName">
      <message key="name.invalidPattern" value="名称 ''{0}'' 必须符合正则表达式 ''{1}''."/>
    </module>
    <module name="MagicNumber">
      <property name="severity" value="warning"/>
      <message key="magic.number" value="''{0}'' 是一个魔法数(即常数)."/>
    </module>
    <module name="NeedBraces">
      <message key="needBraces" value="''{0}'' 结构必须要用大括号 '''{}'''s."/>
    </module>
    <module name="AvoidInlineConditionals">
      <property name="severity" value="warning"/>
      <message key="inline.conditional.avoid" value="避免内部条件语句,不易于代码阅读."/>
    </module>
    <module name="EmptyStatement">
      <message key="empty.statement" value="空代码块."/>
    </module>
    <module name="ModifiedControlVariable"/>
    <module name="ParameterNumber">
      <property name="severity" value="warning"/>
      <property name="max" value="5"/>
      <property name="tokens" value="METHOD_DEF"/>
      <message key="maxParam" value="超过 {0,number,integer} 参数."/>
    </module>
    <module name="JavadocType">
      <property name="authorFormat" value="\S"/>
      <message key="type.missingTag" value="注解缺少 {0} tag."/>
      <message key="javadoc.missing" value="缺少注解"/>
      <message key="javadoc.unusedTagGeneral" value="不使用的注解tag"/>
      <message key="type.tagFormat" value="注解tag {0} 必须符合正则表达式 ''{1}''."/>
    </module>
    <module name="ParameterName">
      <message key="name.invalidPattern" value="名称 ''{0}'' 必须符合正则表达式 ''{1}''."/>
    </module>
    <module name="UnusedImports">
      <message key="import.unused" value="没被使用过 import - {0}."/>
    </module>
    <module name="LineLength">
      <property name="max" value="120"/>
      <message key="maxLineLen" value="行字符数超过 {0,number,integer} 个."/>
    </module>
    <module name="MethodLength">
      <property name="max" value="40"/>
      <property name="tokens" value="METHOD_DEF"/>
      <message key="maxLen.method" value="方法长度 {0,number,integer} 行 (最大允许行数为 {1,number,integer})."/>
    </module>

    
    <module name="MethodParamPad"/>
    <module name="ModifierOrder">
      <message key="mod.order" value="''{0}'' 修饰符没有按照 JLS 的建议顺序."/>
      <message key="annotation.order" value="''{0}'' 注释修饰符不能在非注释修饰符前面."/>
    </module>
    <module name="RedundantModifier">
      <message key="redundantModifier" value="冗余 ''{0}'' 修饰符."/>
    </module>
    <module name="AvoidNestedBlocks">
      <property name="severity" value="warning"/>
      <property name="allowInSwitchCase" value="true"/>
      <message key="block.nested" value="避免代码块的嵌套"/>
    </module>
    <module name="StringLiteralEquality">
      <message key="string.literal.equality" value="字符串比较必须使用 equals(), 而不是 ''{0}''."/>
    </module>
    <module name="NestedIfDepth">
      <property name="severity" value="warning"/>
      <property name="max" value="3"/>
      <message key="nested.if.depth" value="if-else嵌套语句个数为 {0,number,integer} (最大允许嵌套语句个数为: {1,number,integer})."/>
    </module>
    <module name="NestedTryDepth">
      <property name="max" value="2"/>
    </module>
    <module name="SuperClone">
      <message key="missing.super.call" value="方法 ''{0}'' 需要调用 ''super.{0}''."/>
    </module>
    <module name="SuperFinalize">
      <message key="missing.super.call" value="方法 ''{0}'' 需要调用 ''super.{0}''."/>
    </module>
    <module name="IllegalCatch">
      <property name="illegalClassNames" value="java.lang.Exception"/>
      <message key="illegal.catch" value="Catching ''{0}'' 是不允许的."/>
    </module>
    <module name="PackageDeclaration">
      <message key="missing.package.declaration" value="缺少包的定义."/>
      <message key="package.dir.mismatch" value="包定义与目录名不匹配 ''{0}''."/>
    </module>
    <module name="ReturnCount">
      <property name="severity" value="warning"/>
      <property name="max" value="3"/>
      <property name="format" value="^$"/>
      <message key="return.count" value="Return 个数 {0,number,integer} (最大允许个数为: {1,number,integer})."/>
    </module>
    <module name="ParameterAssignment">
      <message key="parameter.assignment" value="参数赋值 ''{0}'' 是不允许的."/>
    </module>
    <module name="MultipleStringLiterals">
      <property name="severity" value="warning"/>
    </module>
    <module name="UnnecessaryParentheses"/>
    <module name="JavadocMethod">
      <property name="suppressLoadErrors" value="true"/>
    </module>
  </module>
  <module name="StrictDuplicateCode">
    <property name="min" value="8"/>
    <message key="duplicates.lines" value="从第 {2}开始,有{0}行相同代码 与 {1}中重复."/>
  </module>
  <module name="FileLength">
    <property name="severity" value="warning"/>
    <property name="max" value="1500"/>
    <message key="maxLen.file" value="文件 {0,number,integer} 行 (最大行数为: {1,number,integer})."/>
  </module>
  <module name="Translation">
    <message key="translation.missingKey" value="关键字 ''{0}'' 没找到."/>
  </module>
</module>

 

分享到:
评论

相关推荐

    Eclipse_CheckStyle配置

    Eclipse的CheckStyle配置,实践经验建议配置。

    checkstyle配置文件说明

    配置文件是 Checkstyle 工作的核心,它定义了一系列规则来确保代码遵循特定的编码规范。以下是对 Checkstyle 配置文件中各个模块及其功能的详细说明: 1. **basedir**:设置代码所在的目录,用于确定相对路径的基...

    checkstyle配置文件

    checkstyle 配置文件

    CheckStyle配置详解

    CheckStyle配置详解,看到的比较详细的介绍,分享一下

    代码格式检查工具Checkstyle配置详解

    ### Checkstyle配置详解 #### 一、概述 随着软件项目的复杂性和规模不断扩大,代码的一致性和规范性变得尤为重要。为了确保代码质量并提高团队协作效率,很多开发团队都会采用一些工具来自动化检查代码风格和规范...

    Eclipse\CheckStyle代码风格配置文件

    这个压缩包文件包含了与Eclipse集成的CheckStyle配置文件及相关操作步骤,旨在帮助开发者实现一致且高质量的代码风格。 1. **CheckStyle概述**: CheckStyle是一个静态代码分析工具,它通过检查源代码是否遵循预...

    checkstyle导入阿里巴巴规范流程

    安装完成后,你需要获取阿里巴巴的Checkstyle配置文件,这通常可以在阿里巴巴开源项目的GitHub仓库中找到,如Alibaba Java Coding Guidelines。 1. **配置Checkstyle**: - 在Eclipse中,你可以通过Window -&gt; ...

    在eclipse中使用checkStyle

    在这里,你可以配置CheckStyle的基本设置,包括导入已有的CheckStyle配置文件。配置文件定义了代码检查的规则集,例如命名规范、空格使用、注释格式等。如果没有现成的配置文件,可以使用CheckStyle提供的默认配置,...

    checkstyle使用说明

    `Checkstyle的配置详解.pdf`文件很可能包含了如何设置和调整Checkstyle配置的详细指南。通常,配置文件是一个XML文件(如`checkstyle.xml`),其中包含了要启用的检查器(Checker)、模块(Module)和它们的参数。...

    checkstyle配置文档

    checkstyle配置文档Checkstyle的检查项配置详解

    Checkstyle配置和eclipse离线插件包

    checkstyle的eclipse离线安装包、checkstyle的配置文件。 在eclipse上Checkstyle的安装和使用请参考下面的文章 http://blog.csdn.net/ccboy2009/article/details/32318781

    Eclipse代码格式化CodeStyle和CheckStyle配置

    本文将详细介绍如何在Eclipse中配置CodeStyle和CheckStyle,并解析提供的配置文件。 首先,让我们了解CodeStyle和CheckStyle的基本概念: 1. **CodeStyle**:Eclipse的CodeStyle是内置的代码格式化工具,它允许...

    CheckStyle的安装及配置

    1. **启动CheckStyle配置**:打开MyEclipse后,在主界面上找到CheckStyle配置入口。通常可以通过顶部菜单栏中的`Window` -&gt; `Preferences`或者右键项目选择`Properties`等方式进入。 2. **创建新的编码规范**: - ...

    checkstyle-android:Checkstyle配置以匹配Android代码样式准则

    许多Android项目选择遵循这些准则,并且这种checkstyle配置有助于在代码上强制实施它们。 这仍在进行中! 到目前为止,仅执行了一些规则。 查看下面的#Contributing部分以了解如何控制;) 用法 您可以只获取并将其...

    CheckStyle汉化配置文件

    这是两年前一手整理出来的,里边是个xml文件,里边有详细的注释,可以根据自己公司的需求进行调整,直接导入到myEclipse中即可,当时针对的是jdk1.6,对应的checkStyle的版本号是5.6,其他版本没有试过

    Checkstyle的配置说明

    开发者可以根据项目需求自定义Checkstyle配置,添加或移除检查规则,调整规则的参数。例如,如果希望允许方法长度达到50行,可以在配置文件中这样设置: ```xml ``` 五、集成到构建工具 Checkstyle可以轻松地...

    Java代码规范、格式化和checkstyle检查配置文档

    - 配置Checkstyle插件:在Eclipse中导入checkstyle配置文件,设置检查级别,然后在代码编辑器中显示违规提示。 - 快捷修复:Eclipse提供快捷键或菜单选项,可以直接修复部分checkstyle违规问题。 5. **最佳实践**...

    eclipse中配置checkstyle(含插件)

    - 如果需要调整已导入的Checkstyle配置,可以返回"Preferences" -&gt; "Checkstyle" -&gt; "Local Check Configurations",选择对应的配置文件,点击"Edit..."进行修改。 - 修改XML配置文件,可以添加、删除或调整...

    MyEclipse安装和使用checkstyle详解

    2. 加载Checkstyle配置文件:你可以选择使用默认的Checkstyle配置,也可以自定义配置文件。自定义配置文件通常为XML格式,可以从网上下载或根据项目需求自行编写。在配置页面点击"Import"导入配置文件。 3. 配置...

Global site tag (gtag.js) - Google Analytics