Checkstyle 4.3 中文手册

时间：2025-07-12

帮助你发现代码的bad smell

Checkstyle4.3 中文手册

加入OpenDoc前的预览版。预览版。

申思维

1.0

本文根据Checkstyle4.3 英文官方文档而来。我打算发布成OpenDoc, 欢迎大家给我来信，多提意见！谢谢目录

1.1. 概述2. N分钟入门5. 在Ant中使用Checkstyle

5.3. 典型例子

6. 在Eclipse中使用Checkstyle

6.4. 常见问题7.2. JavaDoc注释

7.2.3. 方法的javadoc7.3.2. 注意7.5.1. import中避免星号"*"7.6.1. 文件长度

帮助你发现代码的bad smell

7.6.4. 方法的参数个数7.7.2. 圆括号附近的空格

7.9. 对区域(empty block)的检查

7.9.3. 需要括号的区域

7.10.4. 空语句(statement)

7.10.7. 不合适的初始化7.10.14. 未被简化的条件表达式7.10.17. 嵌套的if 层次7.10.24. JUnitTestCase7.10.27. 参数被赋值

7.10.34. 不使用this

7.11.1. 可见的修改方法

帮助你发现代码的bad smell

7.11.3. Interfacels Type

7.11.6. throws的数量7.13.4. 函数的分支复杂度7.14.1. 禁止使用的表达式7.14.8. final型的参数7.14.11. 必须出现的字符串

术语表参考书目插图清单

2.1. 2.2. 开启Checkstyle

2.3. 2.4. 2.5. 2.6. 使用自定义的Checkstyle配置文件2.7. 2.8. 5.1. 在Ant环境下Checkstyle的所须文件5.2. 5.3. 6.1. 成功安装Checkclipse后的Preferences窗口6.2. 6.3. 6.4. 6.5. Problems的过滤器中配置Checkclipse。6.6. 表格清单

5.1. 5.2. 7.1. 命名约定检查模块一览表7.2. 7.3. 7.4. GenericIllegalRegexp的属性列表

帮助你发现代码的bad smell

7.5. 7.6. Indentation的属性列表

前言

Preface

Checkstyle是非常优秀的代码规范检查软件，可以大幅的提高代码质量，当项目的开发人员比较多时，用它来统一代码风格是很有必要的。

本文的写作，是由于公司的质量管理部门对代码格式进行了要求。在网上也没有发现有比较详细全面的中文文档。所以参考Checkstyle4.3的官方文档写就。

有个比较神奇的20%-80%规律是这样说的：一本书，用的最多的只是20%的内容，它的出现几率是80%；而剩下的80%内容，被使用的不到20%。这个规律也同样适用在其他东东上。只是数据上稍有差异。所以我特意安排了第 4 章用的最多的20%功能，作为典型的使用方法。

对于赶时间的朋友，也可以直接看第 2 章 N分钟入门，可以让你在最快的时间内入门。对于时间充沛的朋友，建议多看看文档。因为作者一再的强调“it is worth reading the documentation”。第 5 章在Ant中使用Checkstyle说明了在ant下的用法。第 6 章在Eclipse中使用Checkstyle说明了Eclipse的插件Checkclipse的用法。

对于初次接触代码规范的朋友，我安排了第 3 章常用的检查，里面是个人以为满足大多数公司要求的检查，包括一个配置文件。

第 7 章各种检查是各种检查的详细用法，读起来比较枯燥，建议象查字典那样有需要时翻阅，所

以放在最后。

欢迎意见

为了加入OpenDoc , 欢迎各位朋友指出文档中的任何错误和不足，也可以给我任何意见。请Email给我：shensiwei(at)http://www.77cn.com.cn

希望本文对您有用。谢谢！

第 1 章介绍

Introduction

目录1.3. 下载

1.1. 概述

Checksytle 是一款代码格式检查工具。它可以根据设置好的编码规则来检查代码。比如符合规范的变量命名，良好的程序风格等等。如果你的项目经理开会时说，“我希望我们写出来的代码就象一个人写的！” 时，用Checkstyle绝对是正确选择。:)

本文档就是在4.3的基础上完成。截止到2008-02-22，最新的版本是4.4。

帮助你发现代码的bad smell

需要强调的是，Checkstyle

只能做检查，而不能做修改代码。

提醒

想修改代码格式，请使用Jalopy. 它和Checkstyle配合使用非常合适。

1.2. 特点

Checkstyle的配置性极强，你可以只检查一种规则，也可以检查三十，四十种规则。可以使用Checkstyle自带的规则，也可以自己增加检查规则。（这点跟自定义target比较象）支持几乎所有主流IDE，包括 Eclipse , IntelliJ, NetBeans, JBuilder 等11种。

1.3. 下载

最新的发布版本在：这里

4.4使用了SVN，关闭了CVS。SVN在各种插件下载，见 Checkstyle主页中的列表。

第 2 章 N分钟入门

extreme learning

让您在几分钟之内了解Checkstyle的大致用法。适合赶时间的朋友。假设您已经安装好了Checkstyle的Eclipse

插件。

测试

欢迎在阅读下一行之前，记录下当前的时间，然后在读完本节之后，算算您用了多少时间。如果方便，请将您用的时间告诉我，谢谢:)

1.首先，我们建立一个eclipse的项目：test_checkstyle。包含一个源文件夹：src，一个目标

生成文件夹 eclipse_build. 如图 2.1 “测试如何使用checkstyle的项目”

所示。