eclipse的checkstyle模板

最新推荐文章于 2021-03-01 17:34:47 发布
最新推荐文章于 2021-03-01 17:34:47 发布
阅读量2.1k 收藏
点赞数
分类专栏： eclipse 文章标签： eclipse interface javadoc class string encoding
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/ahhsxy/article/details/6941424
版权
  
<?xml version="1.0" encoding="UTF-8"?>
<checkstyle-configurations file-format-version="3.2.0">
    <check-configuration name="Java-Branch Check">
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.ArrayTypeStyleCheck"
            comment="配列宣言" severity="warning">
            <config-properties>
                <config-property name="javaStyle" value="true"/>
            </config-properties>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.ModifierOrderCheck" severity="warning">
            <config-properties/>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.UpperEllCheck" severity="warning">
            <config-properties/>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.blocks.AvoidNestedBlocksCheck" severity="warning">
            <config-properties/>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.blocks.EmptyBlockCheck" severity="warning">
            <config-properties>
                <config-property name="option" value="stmt"/>
                <config-property name="tokens" value="LITERAL_CATCH, LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY, LITERAL_IF, LITERAL_FOR, LITERAL_TRY, LITERAL_WHILE, STATIC_INIT"/>
            </config-properties>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.blocks.LeftCurlyCheck"
            comment=""{"について" severity="warning">
            <config-properties>
                <config-property name="maxLineLength" value="120"/>
                <config-property name="option" value="eol"/>
                <config-property name="tokens" value="CLASS_DEF, CTOR_DEF, INTERFACE_DEF, LITERAL_CATCH, LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY, LITERAL_FOR, LITERAL_IF, LITERAL_SWITCH, LITERAL_SYNCHRONIZED, LITERAL_TRY, LITERAL_WHILE, METHOD_DEF"/>
            </config-properties>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.blocks.NeedBracesCheck" severity="warning">
            <config-properties/>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.blocks.RightCurlyCheck"
            comment=""}"について" severity="warning">
            <config-properties>
                <config-property name="option" value="same"/>
                <config-property name="tokens" value="LITERAL_CATCH, LITERAL_ELSE, LITERAL_TRY"/>
            </config-properties>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.coding.DoubleCheckedLockingCheck" severity="warning">
            <config-properties/>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.coding.EmptyStatementCheck" severity="warning">
            <config-properties/>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.coding.EqualsHashCodeCheck" severity="warning">
            <config-properties/>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.coding.HiddenFieldCheck" severity="warning">
            <config-properties/>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.coding.IllegalInstantiationCheck"
            comment="インスタンス化すべきではないクラス" severity="warning">
            <config-properties>
                <config-property name="classes" value="{}"/>
            </config-properties>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.coding.InnerAssignmentCheck" severity="warning">
            <config-properties/>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.coding.MagicNumberCheck" severity="warning">
            <config-properties/>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.coding.MissingSwitchDefaultCheck" severity="warning">
            <config-properties/>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.coding.RedundantThrowsCheck" severity="warning">
            <config-properties>
                <config-property name="allowSubclasses" value="false"/>
                <config-property name="allowUnchecked" value="true"/>
            </config-properties>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.coding.SimplifyBooleanExpressionCheck"
            comment="boolean の冗長な比較の排除" severity="warning">
            <config-properties/>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.coding.SimplifyBooleanReturnCheck"
            comment="returnするboolean値の冗長性の排除" severity="warning">
            <config-properties/>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.coding.StringLiteralEqualityCheck"
            comment="Stringの比較(String1 == String2を禁止） " severity="warning">
            <config-properties/>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck" severity="warning">
            <config-properties/>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.design.HideUtilityClassConstructorCheck" severity="warning">
            <config-properties/>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.design.InterfaceIsTypeCheck" severity="warning">
            <config-properties/>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck"
            comment="クラスメンバのスコープ" severity="warning">
            <config-properties>
                <config-property name="packageAllowed" value="false"/>
                <config-property name="protectedAllowed" value="false"/>
                <config-property name="publicMemberPattern" value="^serialVersionUID"/>
            </config-properties>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.imports.IllegalImportCheck"
            comment="使用禁止インポート" severity="warning">
            <config-properties>
                <config-property name="illegalPkgs" value="sun,java.lang.Thread,java.lang.Timer,java.lang.refrect"/>
            </config-properties>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.imports.RedundantImportCheck" severity="warning">
            <config-properties/>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck" severity="warning">
            <config-properties/>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck"
            comment="メソッドコメント" severity="warning">
            <config-properties>
                <config-property name="allowMissingParamTags" value="false"/>
                <config-property name="allowMissingReturnTag" value="false"/>
                <config-property name="allowMissingThrowsTags" value="false"/>
                <config-property name="allowThrowsTagsForSubclasses" value="false"/>
                <config-property name="allowUndeclaredRTE" value="true"/>
                <config-property name="excludeScope" value="nothing"/>
                <config-property name="scope" value="private"/>
                <config-property name="tokens" value="METHOD_DEF, CTOR_DEF"/>
            </config-properties>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck"
            comment="JavaDocの妥当性チェック　TODO:checkEmptyJavaDoc" severity="warning">
            <config-properties>
                <config-property name="checkEmptyJavadoc" value="false"/>
                <config-property name="checkFirstSentence" value="false"/>
                <config-property name="checkHtml" value="true"/>
                <config-property name="scope" value="private"/>
                <config-property name="tokens" value="INTERFACE_DEF, CLASS_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/>
            </config-properties>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck"
            comment="クラスコメント" severity="warning">
            <config-properties>
                <config-property name="authorFormat" value="\S"/>
                <config-property name="excludeScope" value="nothing"/>
                <config-property name="scope" value="private"/>
                <config-property name="tokens" value="CLASS_DEF, INTERFACE_DEF"/>
                <config-property name="versionFormat" value="\S"/>
            </config-properties>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocVariableCheck"
            comment="クラス変数コメント" severity="warning">
            <config-properties>
                <config-property name="excludeScope" value="nothing"/>
                <config-property name="scope" value="private"/>
            </config-properties>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.naming.ConstantNameCheck"
            comment="定数" severity="warning">
            <config-properties>
                <config-property name="format" value="^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*{1}quot;/>
            </config-properties>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.naming.LocalFinalVariableNameCheck" severity="warning">
            <config-properties/>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.naming.LocalVariableNameCheck"
            comment="ローカル変数" severity="warning">
            <config-properties>
                <config-property name="format" value="^[a-z][a-zA-Z0-9]*{1}quot;/>
            </config-properties>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.naming.MemberNameCheck"
            comment="public以外のメンバ" severity="warning">
            <config-properties>
                <config-property name="applyToPackage" value="true"/>
                <config-property name="applyToPrivate" value="true"/>
                <config-property name="applyToProtected" value="true"/>
                <config-property name="applyToPublic" value="false"/>
                <config-property name="format" value="^[a-z][a-zA-Z0-9]*_{1}quot;/>
            </config-properties>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.naming.MemberNameCheck"
            comment="publicクラスメンバ" severity="warning">
            <config-properties>
                <config-property name="applyToPackage" value="false"/>
                <config-property name="applyToPrivate" value="false"/>
                <config-property name="applyToProtected" value="false"/>
                <config-property name="applyToPublic" value="true"/>
                <config-property name="format" value="^[a-z][a-zA-Z0-9]*{1}quot;/>
            </config-properties>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.naming.MethodNameCheck"
            comment="メソッド名" severity="warning">
            <config-properties>
                <config-property name="format" value="^[a-z][a-zA-Z0-9]*{1}quot;/>
            </config-properties>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.naming.PackageNameCheck"
            comment="パッケージ名" severity="warning">
            <config-properties>
                <config-property name="format" value="^jp\.co\.jcb\.jcb_host\.([a-z0-9]{3}|kuzilla)(\.[a-zA-Z_][a-zA-Z0-9_]*)*{1}quot;/>
            </config-properties>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.naming.ParameterNameCheck"
            comment="引数" severity="warning">
            <config-properties>
                <config-property name="format" value="^[a-z][a-zA-Z0-9]*{1}quot;/>
            </config-properties>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.naming.StaticVariableNameCheck"
            comment="クラス変数" severity="warning">
            <config-properties>
                <config-property name="format" value="^[a-z][a-zA-Z0-9]*__{1}quot;/>
            </config-properties>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.naming.TypeNameCheck"
            comment="クラス名" severity="warning">
            <config-properties>
                <config-property name="format" value="^[A-Z][a-zA-Z0-9]*{1}quot;/>
                <config-property name="tokens" value="CLASS_DEF, INTERFACE_DEF"/>
            </config-properties>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.sizes.ExecutableStatementCountCheck"
            comment="メソッド・コンストラクタ数" severity="warning">
            <config-properties>
                <config-property name="max" value="100"/>
                <config-property name="tokens" value="METHOD_DEF, CTOR_DEF"/>
            </config-properties>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.sizes.FileLengthCheck"
            comment="ファイルサイズ TODO:コメントはカウントされるのか。" severity="warning">
            <config-properties>
                <config-property name="max" value="1000"/>
            </config-properties>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.sizes.LineLengthCheck"
            comment="一行の最大長" severity="warning">
            <config-properties>
                <config-property name="ignorePattern" value="^{1}quot;/>
                <config-property name="max" value="120"/>
                <config-property name="tabWidth" value="4"/>
            </config-properties>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.sizes.MethodLengthCheck"
            comment="メソッドの最大行" severity="warning">
            <config-properties>
                <config-property name="countEmpty" value="false"/>
                <config-property name="max" value="250"/>
                <config-property name="tokens" value="METHOD_DEF, CTOR_DEF"/>
            </config-properties>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.sizes.ParameterNumberCheck"
            comment="パラメータ最大数" severity="warning">
            <config-properties>
                <config-property name="max" value="10"/>
                <config-property name="tokens" value="METHOD_DEF, CTOR_DEF"/>
            </config-properties>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyForIteratorPadCheck" severity="warning">
            <config-properties/>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceAfterCheck" severity="warning">
            <config-properties/>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceBeforeCheck" severity="warning">
            <config-properties/>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.whitespace.OperatorWrapCheck" severity="warning">
            <config-properties/>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.whitespace.ParenPadCheck" severity="warning">
            <config-properties/>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAfterCheck" severity="warning">
            <config-properties/>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAroundCheck" severity="warning">
            <config-properties/>
        </rule-configuration>
    </check-configuration>
</checkstyle-configurations>


关于checkstyle的插件jar，请参照：

http://dl.dbank.com/c0bma9iicj

萧逸2005
关注
专栏目录
提高Java代码质量的Eclipse插件之Checkstyle的使用详解
大闲人柴毛毛
07-17 1652
CheckStyle是SourceForge下的一个项目，提供了一个帮助JAVA开发人员遵守某些编码规范的工具。它能够自动化代码规范检查过程，从而使得开发人员从这项重要但是枯燥的任务中解脱出来。 CheckStyle检验的主要内容  ·Javadoc注释  ·命名约定  ·标题  ·Import语句  ·体积大小  ·空白  ·修饰符  ·块  ·代码问题  ·类设计 
图解Eclipse优化Checkstyle静态分析工具
实践求真知
10-30 521
一安装Checkstyle插件 二 优化模板文件 1复制一份作为要优化的文件 2下面是复制后的结果 3 设置为默认项 4 开始配置 5选择优化项 6开始优化 三 导出模板文件 四 导入模板文件 1新建一个模板 2导入前面导出的模板 3导出后的样子 五优化举例 1.javadoc Comments ...
Eclipse中使用Checkstyle,checkstyle插件检查java代码的自定义配置文件：
迷彩风情
02-03 235
摘要：近来项目组在搞代码检查，所以领导让把checkstyle这个插件搞明白，现在我把我们写的自定义的checkstyle.xml文件记录一下，以便大家可以一起使用： 一：要使用checkstyle插件在eclipse中检查java代码，那必须的先安装eclipse的checkstyle插件，如何安装，我相信大家知道，这里就不多说了 二：下面就是自定义的checkstyle.xml文件(这个是...
IDEA配置代码Checkstyle 报错：com.puppycrawl.tools.checkstyle.api.CheckstyleException
紫蝶侠的博客
03-01 5587
如果报错 降低checkstyle version
Jenkins搭建代码扫描配置说明
fj56355113的专栏
09-15 1153
目 录1. 简介 1.1. 目的 1.2. 范围 2. 所需软件 3. Jenkins环境搭建 3.1. Jenkins安装 3.2. 插件安装 3.2.1. Jenkins插件安装 3.2.2. Nodejs 安装 3.2.3. Eslink 安装 4. Jenkins代码扫描配置 4.1. Java配置 4.1.1. Checkstyle a.集成配置 b.规则说明 4.1.2. FindBugs a.集成配置 b.规则说明 4.1.3. 汇总配置 4.1.4. 统计查看 4.2. 前端配置 4.2.1
SonarQube配置自定义的CheckStyle代码规则
xiaofanren1111的博客
07-12 2958
1、CheckStyle插件安装在应用市场中搜索CheckStyle即可，搜索出来后，点击安装按钮（我这里已经安装了，未安装的情况再卸载按钮的地方会有安装按钮），即可下载安装，安装过程中会有一次重启操作（注：有些版本的SonarQube插件安装是在配置-系统-更新中心）2、配置自定义的CheckStyle代码规则配置自定义的CheckStyle代码规则，有两种方法，使用CheckStyle代码规则...
Eclipse_CheckStyle配置
12-17
Eclipse的CheckStyle配置，实践经验建议配置。
eclipse导入模板.
02-04
4、checkstyle.xml文件，check style规则模板 打开eclipse中菜单"windows"-->Preferences。 选择“CheckStyle” ,然后导入。 5、pmd.xml文件，check style规则模板 打开eclipse中菜单"windows"-->Preferences...
在Eclipse中修改Checkstyle
05-06
4. 代码格式化模板的替换方法：除了Checkstyle规则集之外，Eclipse中还有代码格式化和代码模板的配置，这些配置文件通常存放在特定的目录下，例如fiberhome。文章中提到了如何选择格式化文件和代码注释模板文件，...
在eclipse中修改java格式化模板、checkstyle和pmd规则集的方法
02-25
本教程将详细介绍如何在 Eclipse 中配置和替换 Checkstyle、PMD 的规则集，以及如何修改代码格式化模板。 首先，我们来了解一下 Checkstyle。Checkstyle 是一个开源项目，它提供了对 Java 代码风格的检查，包括但不...
Checkstyle4.4 结合Eclipse配置使用
04-16 2568
Checkstyle4.4 结合Eclipse配置使用前言Checkstyle是非常优秀的代码规范检查软件，可以大幅的提高代码质量， 当项目的开发人员比较多时，用它来统一代码风格是很有必要的。本文的写作，是由于公司的质量管理部门对代码格式进行了要求。第一章       介绍1.1概述Checksytle 是一款代码格式检查工具。它可以根据设置好的编码规则来检查代码。 比如符
解决Checkstyle File Name 异常的问题
技术小黑屋
01-12 1170
Checkstyle是一款很棒的工具，用来发现很多编码风格的问题。还不了解的同学可以移步这里Android代码规范利器： Checkstyle查看。 但是在使用Checkstyle时，却出现了一些问题，就是file元素的name不是我们当前执行checkstyle任务的路径。 举个例子，比如 我们执行./gradlew checkstyle时项目的路径为~/Document/aProject ...
静态代码检查-CheckStyle
NCNC
10-21 8918
提高代码的质量，除了要提高逻辑上的控制以及业务流程的理解外，代码本身也存在提高的空间，例如一些潜在的问题可以很早的就避免。类似于编码规范上的内容，如果全靠编码人员进行自行检查，那么无疑需要很大的工作量，如果可以使用代码的静态检查工具进行检查的话，那么将大大的提高编码的效率。本文是提高代码质量系列文章的第二篇，主要介绍了如何使用checkstyle工具进行代码的自动化检查，以规避一些潜在的问题并
代码检查工具选型
从helloworld到architecture
07-11 476
源码分析工具选型 1. 目前各种主流源码分析工具简单介绍 1.1 checkstyle checkstyle产生于2001年，是以antlr作为java语法分析器的静态源码分析工具。通过checkstyle的xml配置文件可指定源码分析规则。通过继承checkstyle自身的Check可实现新的代码检查逻辑。另外继承AbstractFileSetCheck可实现除java以外的其它编程语言的...
CheckStyle, 强制你遵循编码规范
weixin_33805992的博客
06-21 314
如今代码静态检查越来越重要，已经成为构建高质量软件的不可或缺的一个验证步骤。如果你使用的是java语言，那么CheckStyle则是一个利器。 CheckStyle能够帮助程序员检查代码是否符合制定的规范。通过将CheckStyle的检查引入到项目构建中，可以强制让项目中的所有的开发者遵循制定规范，而不是仅仅停留在纸面上。如果发现代码违反了标准，比如类名未以大写开头、单个方法超过了指...
JAVA 静态代码分析--规范检查-checkstyle
热门推荐
漫步
11-19 3万+
JAVA 代码分析 http://www.oschina.net/question/129540_23043
编码规范(二)----JAVA编码规范插件
fendo
12-18 7671
一、前言 在项目开发的过程中，很多时候，无法统一大家的编码规范，你有你的风格，我有我的风格，虽然每个公司都有自己的规范，但是有时候，作为开发人员的我们，写者写着，就按自己的来了，反正有没有人来检查，或者是人为的检查感觉费时间，这时候，就可以通过一些代码插件工具来提高我们的效率，目前常见的有:CheckStyle、阿里巴巴的p3c插件等。 CheckStyle简介
android studio中配置代码检查-CheckStyle
gengbaolong的博客
10-14 1625
为了规范编码，使用到了CheckStyle。 CheckStyle的主要功能就是实时检测，代码的规范（Code Style）是否符合我们规定的一个模板，如代码和括号之间没有空格，类中导入的包没有使用等，当发现这些不符合这些规范时，它就报一个警告或者错误等提示，导致编译不通过。 CheckStyle检验的主要内容 Javadoc注释 命名约定 标题 Import语句 体积大小 ...
评论 2
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值