编辑“︁Checkstyle”︁

{{noteTA|G1=IT}}
{{ Infobox software
| name                   = Checkstyle
| logo                   = 
| screenshot             = 
| caption                = 
| developer              = 
| operating system       = [[跨平台]]
| language               = 
| programming language   = [[Java]]
| genre                  = [[静态代码分析]]
| license                = [[GNU宽通用公共许可证]]
| website                = {{url|http://checkstyle.sourceforge.net}}
}}

'''Checkstyle'''<ref>{{cite web | url = http://checkstyle.sourceforge.net/ | title = Checkstyle Home Page | year = 2010 | accessdate = 2010-11-02 | archive-date = 2011-03-17 | archive-url = https://web.archive.org/web/20110317195543/http://checkstyle.sourceforge.net/ | dead-url = no }}</ref>是在[[软件开发]]中的一种[[静态代码分析]]工具，用来检查[[Java]][[源代码]]是否符合[[代码风格|编码规则]]。

== 模块 ==

'''Checkstyle'''定义了一组可用的模块，每个模块都提供可配置严格程度的规则（强制性的、可选的等）。每项规则都可以发出通知、警告和错误。例如，Checkstyle可以检查下列问题：

* 类、属性和方法的[[Javadoc]]；
* 属性和方法的命名规范；
* 函数参数数量、代码行的长度的限制；
* 标题是否存在<ref>{{cite web|title=Header|url=http://checkstyle.sourceforge.net/config_header.html|accessdate=2014-06-11|archive-date=2014-10-04|archive-url=https://web.archive.org/web/20141004153223/http://checkstyle.sourceforge.net/config_header.html|dead-url=no}}</ref>；
* 包的导入、类、访问控制修饰符、代码块的使用；
* [[字符]]间的间隔；
* [[重复代码]]<ref>{{cite web |url=http://checkstyle.sourceforge.net/config_duplicates.html |title=Checkstyle Duplicate Code Check |year=2010 |accessdate=2010-11-02 |deadurl=yes |archiveurl=https://web.archive.org/web/20101208195424/http://checkstyle.sourceforge.net/config_duplicates.html |archivedate=2010-12-08 }}</ref>；
* 代码中多种[[軟體度量|复杂度的度量]]

== 用法 ==

'''Checkstyle'''构建成一个[[JAR (文件格式)|JAR文件]]中，继可以运行在[[Java虚拟机]]上，又可以作为一个[[Apache Ant]]任务。它还可以集成到[[集成开发环境]]或其他工具中。

Checkstyle插件还可以提供其他功能，例如:
* 重载代码编辑器的[[语法高亮]]；
* 在项目浏览器里突出显示存在问题的代码项；
* 在输出窗口中添加警告和错误输出

这样一来，开发者可以直接访问被Checkstyle高亮的代码部分。

== 历史 ==

Checkstyle最初由Oliver Burn于2001年开始开发，由来自世界各地的几个开发者组成的开发团队维护。

版本5.6是目前的稳定版本，其针对的是[[Java 7]]。

== 参见 ==
{{Portal|自由软件}}
* {{tsl|en|List of tools for static code analysis|静态代码分析工具列表}}
* [http://eclipse-cs.sourceforge.net/index.html EclipseCS]{{Wayback|url=http://eclipse-cs.sourceforge.net/index.html |date=20140328020320 }} - Checkstyle的Eclipse插件

== 参考文献 ==
{{Reflist}}

== 拓展阅读 ==
*[http://www.javatips.net/blog/2013/07/eclipse-checkstyle-tutorial Eclipse Checkstyle 教程]{{Wayback|url=http://www.javatips.net/blog/2013/07/eclipse-checkstyle-tutorial |date=20140701162759 }}

[[Category:静态代码分析工具]]
[[Category:Java函式庫]]
[[Category:Java开发工具]]
[[Category:使用LGPL许可证的软件]]