Checkstyle

来自Local Chinese Wikipedia
跳转到导航 跳转到搜索
Checkstyle
当前版本
    Module:EditAtWikidata第29行Lua错误:attempt to index field 'wikibase' (a nil value)
    源代码库
    • {{URL|example.com|可选的显示文本}}
    Module:EditAtWikidata第29行Lua错误:attempt to index field 'wikibase' (a nil value)
    编程语言Java
    引擎
      Module:EditAtWikidata第29行Lua错误:attempt to index field 'wikibase' (a nil value)
      操作系统跨平台
      类型静态代码分析
      许可协议GNU宽通用公共许可证
      网站checkstyle.sourceforge.net

      Checkstyle[1]是在软件开发中的一种静态代码分析工具,用来检查Java源代码是否符合编码规则

      模块[编辑]

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

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

      用法[编辑]

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

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

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

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

      历史[编辑]

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

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

      参见[编辑]

      参考文献[编辑]

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

      拓展阅读[编辑]