参考官网教程:http://checkstyle.sourceforge.net/config_blocks.html;
checkstyle是一个开发工具,帮助我们检查代码大部分不规范地方,提高检查效率,也节约大量人工审查成本,也可以支持开发自定义规则,适应项目的风格。
兼容ide插件:eclipse,idea;
文章主要介绍下checkstyle自定义规则的大概用法,checkstyle是通过xml来管理每个check模块,通过配置我们需要的模块(module),目前checkstyle已经提供了很多模块给我们使用,直接应用就可以了。
xml的格式:
- <module name="Checker">
- <property name="severity" value="error"/>
- <module name="TreeWalker">
- <module name="AvoidStarImport"/>
- <module name="ConstantName"/>
- <module name="EmptyBlock"/>
- ....
- </module>
- </module>
针对官网的案例,详细描述具体用途:
1.<module name="Checker">定义标准xml的根模块节点;
2.<property name="severity" value="error"/>全局属性,定义严重级别;
3. <module name="TreeWalker"> 定义检查的语法树,包含多个我们需要的检查的模块,在代码进行check操作的时候会工具配置的子节点模块进行check;
4.AvoidStarImport(import语句不使用通配符),ConstantName(常量命名),EmptyBlock(空的代码块)等标准的checkstyle模块;
checkstyle提供的标准模块,我们可以在<TreeWalker>工具需要应用
1.Annotations 注解;
2.Block Check 代码块;
3.Class Design 类设计;
4.Codding 代码风格;
5.Javadoc Comments 注释;
6.Regexp 正则表达匹配,自己定义正在表达;
......
注:以上是常用的几个模块,具体每个模块的参数使用可以参考官网的文档具体描述;
附件是参考的自定配置的模板,可以参考下,借鉴的是网上一个哥们共享的,并且自己又修改增加一些验证模块,idea使用过没问题,非常感谢分享。
分享到:
相关推荐
包括Checkstyle在Eclipse中和Maven中的配置详解,下了绝不后悔,一文在手,开发不愁
代码走查工具CheckStyle插件的安装和使用
checkstyle findbugs 包含幻灯片,资料全
最新版本的checkstyle插件,很好的代码走查工具,附带安装步骤.
作为一名开发人员,我们的工作就是为终端用户将过程自动化;然而,我们当中有很多人却忽视了将我们自己的开发过程自动化的机会。为此,我编写了让开发自动化 这个系列的文章,专门探索软件开发过程自动化的实际应用...
CheckStyle 代码优化工具 代码格式 java格式
checkStyle java代码检查工具
Alibaba Java Coding Guidelines是一款为Java开发者提供的插件,旨在帮助开发者遵循阿里巴巴Java开发手册中的编程规范。该插件具有以下优点: 规范性强:阿里巴巴Java开发手册是业内公认的Java编程规范标准,其中...
成员聊天:checkstyle,checkstyle是一个开发工具,可以帮助程序员编写遵循编码标准的java代码。默认情况下,它支持google java风格指南和sun代码约定,但高度可配置。它可以通过ant任务和命令行程序调用。.zip
介绍 Checkstyle是一个开发工具,可以帮助编程人员编写符合编码规范的java 代码 。程序员都非常讨厌程序的check工作,checkstyle能够自动地完成这项烦琐但又非常重要的工作 ,从而节省了的程序员的时间,也提高了...
代码检查 CheckStyle-IDEA,可以本地加载该插件,避免因为墙的原因长时间无法下载带来的困扰。
CheckStyle代码检查工具使用说明
Checkstyle是一个开发工具,可以帮助编程人员编写符合编码规范的java 代码
Checkstyle是SourceForge下的一个开源项目,提供了一个帮助JAVA开发人员遵守某些编码规范的工具。它能进行自动化代码规范检查,从而使得开发人员从这项重要但又枯燥的任务中解脱开来
该文件包含了svn代码检查工具的相关安装包和说明文档
一个优秀的java代码规则检查工具。 可以上官方网站看看使用手册。 地址如下:xxx.com
eclipse_checkstyle代码规范安装,eclipse_checkstyle代码规范安装
目前市场上的 Java 静态代码分析工具种类繁多且各有千秋,我们项目调研现有 4 种主流 Java 静态代码分析工具 (Checkstyle,FindBugs,PMD,Jtest),其中引入并集成了Checkstyle,FindBugs,PMD这三种静态代码工具。
Java代码规范、格式化和checkstyle检查配置文档