Checkstyle

模块

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

  • 类、属性和方法的Javadoc
  • 属性和方法的命名规范;
  • 函数参数数量、代码行的长度的限制;
  • 标题是否存在[2]
  • 包的导入、类、访问控制修饰符、代码块的使用;
  • 字符间的间隔;
  • 重复代码[3]
  • 代码中多种复杂度的度量

用法

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

Checkstyle插件还可以提供其他功能,例如:

  • 重载代码编辑器的语法高亮
  • 在项目浏览器里突出显示存在问题的代码项;
  • 在输出窗口中添加警告和错误输出

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

历史

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

版本5.6是目前的稳定版本,其针对的是Java 7

参见

参考文献

  1. . 2010 [2010-11-02]. (原始内容存档于2011-03-17).
  2. . [2014-06-11]. (原始内容存档于2014-10-04).
  3. . 2010 [2010-11-02]. (原始内容存档于2010-12-08).

拓展阅读

This article is issued from Wikipedia. The text is licensed under Creative Commons - Attribution - Sharealike. Additional terms may apply for the media files.