`
knight_black_bob
  • 浏览: 850340 次
  • 性别: Icon_minigender_1
  • 来自: 北京
社区版块
存档分类
最新评论

checkstyle 使用

阅读更多

 下载: checkstyle 规范 (包含 codeformatter codetemplates checkstyle 文件)

http://download.csdn.net/download/knight_black_bob/9640991

 

下载 checkstyle 插件

http://download.csdn.net/download/knight_black_bob/9643244

 

 

 

一、配置 Code Templates

 设置 Eclipse 代码模版

打开 Eclipse 设置面板,选择 Java -> Code Style -> Code Templates

如图: 



 

点击右边的 Import…按钮,选择 codetemplates.xml 文件,确定即

可。 

 

 

 

二、配置使用 4 个空格代替 tab

tab键在不同的IDE、编辑器(例如EditPlusUltraEdit等)中使用

的空格数不同,因此为了统一,开发人员统一使用4个空格代替tab

键。

打开 Eclipse 设置面板,选择 General -> Editors -> Text Editors

如图: 



 

勾选 Insert spaces for tabs,并设置 Displayed tab width 4

三、配置 Code Formatter

3.1 设置 Eclipse 的代码格式化模版

打开 Eclipse 设置面板,选择 Java -> Code Style -> Formatter,如图:

 

 

点击右边的 Import…按钮,选择 codeformatter.xml 文件,确定即

可。

3.2 格式化使用说明

若要对某个文件进行格式化,可使用如下几种方法:

1.打开文件后,在代码区域采用“CTRL + SHIFT + F”快捷键;

2.打开文件后,在代码区域点击右键选择 Source -> Format

能。

   【说明】建议采用 CTRL + Shift + F 快捷

 

四、配置 Checkstyle 

4.1 ant 集成

要在 ant 工程中使用 Checkstyle,需要先安装 checkstyle jar 包,以

checkstyle-6.15-all.jar 为例,这个包中包含了运行 Checkstyle 需要的类文件。

接下来就是在 build.xml 文件中添加 taskdef 的声明: 

 

<taskdef resource="com/puppycrawl/tools/checkstyle/ant/checkstyle-ant-task.properties"          classpath="/path/to/checkstyle-6.15-all.jar"/> 然后添加一个 checkstyle 的 target。
<target name="checkstyle" >
  <checkstyle config="checkstyle.xml" failureProperty="checkstyle.failure"
failOnViolation="false">
  <formatter type="xml" tofile="${result.xml}/checkstyle_report.xml"/>
    <fileset dir="/home/jenkins/workspace/JAVA_checkstyle_ANT"
includes="**/*.java"/>
  </checkstyle>
  <style in="${result.xml}/checkstyle_report.xml" 
out="${result.html}/checkstyle_report.html"  style="${basedir}/checkstyle.xsl" /> 
  <fail if="checkstyle.failure">
          Checkstyle failed.
        </fail>
</target> 

 

可以运行 ant checkstyle 进行扫描。详细结果信息被存放在

${result.xml}/checkstyle_report.xml 中。

4.2 MAVEN 集成

maven 中一个名为 maven-checkstyle-plugin 的插件,用于执行

CheckStyle task。下面是一个简单的配置。

 

<reporting> 

     <plugins> 

      <plugin> 

        <groupId>org.apache.maven.plugins</groupId> 

        <artifactId>maven-checkstyle-plugin</artifactId> 

        <version>2.9.1</version> 

<configuration> 

           <configLocation> config/maven_checks.xml</configLocation> 

<includes> 

            **\/package\/**.java,**\/otherpackage\/**.java 

             </includes> 

            </configuration> 

    </plugin> 

        <plugin> 

            <groupId>org.apache.maven.plugins</groupId> 

            <artifactId>maven-jxr-plugin</artifactId> 

            <version>2.3</version> 

         </plugin> 

        </plugins> 

</reporting> 

 

可以运行 mvn checkstyle:checkstyle 进行扫描。checkstye 的详细结果信息被

存放在 target/checkstyle-result.xml 中。

4.3 跳过对指定文件的某些检查

如果对于指定文件的某些行检查出了一些问题,但是你想忽略它,则可以使用 suppression方法是建立一个 checkstyle-suppressions.xml 文件。其中加入下述内容

 

<?xml version="1.0"?> 
<!DOCTYPE suppressions PUBLIC       
  "-//Puppy Crawl//DTD Suppressions 1.0//EN"        
 "http://www.puppycrawl.com/dtds/suppressions_1_0.dtd"> 
 
<suppressions>     
<suppress checks="MagicNumberCheck"              
 files="SessionMessageSource.java"               
lines="221,250-295"/>

 </suppressions> 

 

 

然后配置 maven-checkstyel-plugin,在<configuration>……</configuration>

中添加下列两句: <suppressionsLocation>path/to/checkstylesuppressions.xml</suppressionsLocation> <suppressionsFileExpression>checkstyle.suppressions.file</suppressionsFileExp ression>

4.4 Jenkins 输出报告

在运行完 checkstyle 之后,可以使用 Publish Checkstyle analysis results

件,它可以解析生成的 xml 结果文件。 

1 Checkstyle 报告输出插件 



 

2 jenkins 输出 Checkstyle 报告

 

 

 

 

添加checkstyle 插件



 

 

 

添加 checkstyle.xml 为默认检测



 

 

eclipse > preferences > checkstyle > new > external configuration file > ok

> set as default

 

设置为默认

 

项目右键 format 一下 ,出现 checkstyle 报错



 

 

 

 

 

 _NA_SA  配置命令

mvn clean install checkstyle:checkstyle findbugs:findbugs -Dmaven.test.skip=true

 

 

 

 

 

 

 

 

 

 

 

 

 

 

捐助开发者

在兴趣的驱动下,写一个免费的东西,有欣喜,也还有汗水,希望你喜欢我的作品,同时也能支持一下。 当然,有钱捧个钱场(右上角的爱心标志,支持支付宝和PayPal捐助),没钱捧个人场,谢谢各位。



 
 
 谢谢您的赞助,我会做的更好!

 

 

 

 

 

  • 大小: 79.4 KB
  • 大小: 79.7 KB
  • 大小: 145.9 KB
  • 大小: 61 KB
  • 大小: 62.9 KB
  • 大小: 124.6 KB
  • 大小: 124.4 KB
1
0
分享到:
评论

相关推荐

    Checkstyle 使用手册 以及常用方法

    这个"Checkstyle 使用手册 以及常用方法"涵盖了Checkstyle的基本使用和一些常见功能的详细解释。 首先,了解如何配置和运行Checkstyle至关重要。Checkstyle可以通过命令行、IDE插件(如Eclipse、IntelliJ IDEA)...

    CheckStyle使用详解.doc

    "CheckStyle使用详解" CheckStyle是一款功能强大且操作简单的代码检查工具,它可以与Ant结合使用,并且是Open Source的,这意味着用户不需要担心收到律师函。CheckStyle的主要功能是检查Java代码的格式和风格,以...

    CheckStyle使用说明.pdf

    ### CheckStyle 使用说明详解 #### 一、引言 随着软件项目的规模不断扩大,代码的质量问题逐渐成为制约项目进度的关键因素之一。为了确保代码的一致性和可维护性,很多团队都会制定一套编码规范,并定期进行代码...

    checkstyle使用说明

    【Checkstyle使用说明】 Checkstyle是一款强大的Java代码检查工具,它可以帮助开发者遵循特定的编码规范和最佳实践。这款工具广泛应用于各种项目,以确保代码的一致性和可维护性。通过执行一系列预定义的规则,...

    checkstyle使用手册

    ### CheckStyle 使用手册知识点详述 #### 一、CheckStyle 概述 - **定义**:CheckStyle 是 SourceForge 下的一个开源项目,旨在为 Java 开发者提供一套自动化工具,帮助他们遵循一定的编码规范和标准。 - **核心...

    CheckStyle使用手册

    《CheckStyle使用手册》 CheckStyle是一款用于检查Java源代码风格的工具,它可以帮助开发者遵循特定的编码规范和约定,确保代码的一致性和可读性。这篇使用手册将深入介绍CheckStyle的功能、配置以及如何在实际开发...

    Checkstyle使用教程

    Checkstyle 使用教程 Checkstyle 是一个开发工具,可以帮助编程人员编写符合编码规范的 Java 代码。它可以自动地完成代码检查工作,从而节省了程序员的时间,也提高了检查的质量。Checkstyle 已经成了加强编码规范...

    Checkstyle 使用说明书

    这份使用说明书主要涵盖了在 Eclipse 集成环境中以及通过命令行使用 Checkstyle 的方法。 在 Eclipse 中集成 Checkstyle 插件(eclipse-cs)的步骤如下: 1. 首先,下载 eclipse-cs 插件并将其 `features` 和 `...

    CheckStyle使用详解.docx

    Checkstyle 是一个强大的开源代码检查工具,主要用于确保代码遵循特定的编码规范和风格。它能够帮助开发者维护一致的代码质量,提高代码可读性和可维护性。Checkstyle 可以集成到开发环境中,如 Ant、Maven 或者 IDE...

    Checkstyle的安装文件和使用说明

    Checkstyle是一款广泛使用的Java编程语言的静态代码分析工具,它帮助开发者遵循特定的编码规范和最佳实践,确保代码的一致性和可读性。本指南将详细介绍Checkstyle的安装过程、配置方法以及如何在项目中使用它。 ...

    Checkstyle使用说明

    Checkstyle 是一个开源的...2. **引入 Checkstyle Task**: 使用 `taskdef` 元素引入 Checkstyle 的任务定义,需要指定资源文件(通常是 `checkstyletask.properties`)以及 Checkstyle JAR 文件的类路径引用。 ```xml ...

    Eclipse 中CheckStyle安装和使用(转)

    对于更详细的CheckStyle使用方法和配置选项,可以参考官方文档和社区资源,例如给出的文档《checkstyle的使用.docx》。 总之,CheckStyle是Eclipse开发者的重要辅助工具,它能帮助我们遵循编码规范,提升代码质量。...

    checkStyle Xml示例.docx

    CheckStyle Xml 示例文档分析 CheckStyle 是一个流行的 ...通过对 CheckStyle Xml 文件的分析,我们可以了解到 CheckStyle 的基本结构和配置参数,理解 CheckStyle 的使用场景和优点,从而提高代码的质量和可维护性。

    checkstyle中文帮助文档

    9. **常见问题**:文档中通常会列出一些用户可能遇到的问题及其解决方案,帮助用户更好地理解和解决Checkstyle使用过程中遇到的困难。 总的来说,Checkstyle中文帮助文档是学习和使用Checkstyle进行代码质量管理的...

    Findbugs Checkstyle Jupiter使用说明

    FindBugs Checkstyle Jupiter 使用说明 FindBugs 是一个静态代码分析工具,用于检测 Java 代码中的错误和不良编程实践。它可以帮助开发者在编码过程中发现问题,从而提高代码质量。 FindBugs 使用说明 FindBugs ...

Global site tag (gtag.js) - Google Analytics