Check Code with Checkstyle

原创 2011年01月08日 01:04:00

pom.xml

 

<plugins>   

     ...

<plugin>
       <groupId>org.apache.maven.plugins</groupId>
       <artifactId>maven-checkstyle-plugin</artifactId>
       <version>2.6</version>
       <configuration>
            <configLocation>/tdd-config/checkstyle.xml</configLocation>
            <suppressionsLocation>/tdd-config/checkstyle-suppression.xml</suppressionsLocation>
            <suppressionsFileExpression>/tdd-config/checkstyle-suppression.xml</suppressionsFileExpression>
       </configuration>
      </plugin>

      ...

</plugins>

 

checkstyle.xml和checkstyle-suppression.xml

如pom.xml中红色字体所示:/tdd-config/checkstyle.xml & /tdd-config/checkstyle-suppression.xml

checkstyle.xml和checkstyle-suppression.xml包含在tdd-config目录中,tdd-config目录和pom.xml在同一目录下

1. checkstyle.xml定义的代码检查规范内容如下:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.2//EN" "http://www.puppycrawl.com/dtds/configuration_1_2.dtd">
<module name="Checker">
    <property name="severity" value="warning"/>
    <property name="localeCountry" value="US"/>
    <property name="localeLanguage" value="en"/>


    <module name="SuppressionFilter">  
         <property name="file" value="./tdd-config/checkstyle-suppression.xml" />  
    </module>
 

    <module name="TreeWalker">
        <property name="tabWidth" value="2"/>
        <module name="MagicNumber">
            <property name="ignoreNumbers" value="-1, 0, 1"/>
        </module>

         ... ...

     </module>

     ... ...

</module>

 

两点注意:

1)./tdd-config/checkstyle-suppression.xml: 剔除的特定包

2)仔细些会发现在checkstyle的配置中, "."代表的不是当前目录而是父目录,这一点和常识不太一致,但确实要这样配置

 

2. checkstyle-suppression.xml定义的剔除规则内容如下:

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE suppressions PUBLIC
    "-//Puppy Crawl//DTD Suppressions 1.1//EN"
 "http://www.puppycrawl.com/dtds/suppressions_1_1.dtd">

<suppressions>
    <!-- Suppress all checkstyle for autogenerated packages included digital such as: _2009, _2010, _bt_ .etc -->
    <suppress checks="." files="[_]+[0-9]+"/>
    <suppress checks="." files="[_]+[bt]+[_]+"/>
 
</suppressions>

 

Checkstyle in Hudson

非常简单不再详述

 

符合阿里巴巴代码规范的checkstyle检测文件

一、安装与简介eclipse和idea都有对应的插件,找到插件安装界面。搜索checkstyle,点击安装后,重启IDE即可。(网上有很多安装教程,就不重复制造轮子了)二、导入配置文件在checkst...
  • KingBoyWorld
  • KingBoyWorld
  • 2017年07月25日 16:24
  • 4043

CheckStyle报错的常见问题及解决方式

CheckStyle报错的常见问题及解决方式
  • simon_world
  • simon_world
  • 2014年10月19日 00:41
  • 9182

玩转Eclipse — 自动代码规范检查工具Checkstyle

大项目都需要小组中的多人共同完成,但是每个人都有自己的编码习惯,甚至很多都是不正确的。那么如何使小组所有开发人员都遵循某些编码规范,以保证项目代码风格的一致性呢?如果硬性地要求每个开发人员在提交代码之...
  • GarfieldEr007
  • GarfieldEr007
  • 2017年01月14日 17:05
  • 4560

Automated code reviews with Checkstyle, Part 1

Automated code reviews with Checkstyle, Part 1 Automated code reviews with Checkstyle, Part 1 By S...
  • liq2004
  • liq2004
  • 2011年12月20日 06:39
  • 476

checkstyle_eclipse5.3插件 及最sun_check.rar

  • 2010年10月25日 15:30
  • 9.66MB
  • 下载

Eclipse java code checkstyle

  • 2017年04月02日 13:22
  • 9.67MB
  • 下载

my c code check a num whether it is a int

  • 2017年07月29日 16:58
  • 724B
  • 下载

Nordic51822 和 52832 的 APP_ERROR_CHECK(err_code)程序错误检查

  • 2017年06月26日 01:35
  • 731KB
  • 下载

Custom Fxcop rule to check hard code in project

  • 2013年09月06日 12:01
  • 414KB
  • 下载

code check

  • 2011年07月01日 17:27
  • 16KB
  • 下载
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:Check Code with Checkstyle
举报原因:
原因补充:

(最多只允许输入30个字)