Checkstyle是一款为Java代码实施编码约定和最佳时间规则的开源工具,尽管它最初被设计用于实施编码标准,但现在它也允许用户检查最佳编码实践。它分析Java源代码并报告违反标准的情况,可以通过插件将其继承到自己喜欢的继承开发环境中,以便开发人员能够立即看到并纠正违反正式标准的情况。
Checkstyle提供了现成的标准Sun约定,包括120个规则和标准,这些约定能够处理各种问题:从代码格式、命名约定,企业JavaBean(EJB)最佳时间,到代码复杂性度量。Checkstyle支持与以下方面有关的标准:
-
Javadoc注释
-
命名约定
-
文件头
-
导入语句
-
空白
-
修饰符
-
代码块
-
编码问题
-
类设计
-
J2EE
-
Eclipse安装和使用Checkstyle操作步骤
-
在Eclipse中Checkstyle插件的安装
选择Help->Eclipse Market->Search。搜索Checkstyle插件,并安装
-
为特定项目激活Checkstyle检查
一旦安装好插件,需要为特定项目激活Checkstyle检查,默认情况下不会为项目激活Checkstyle。选择项目,右键->Propterties->Checkstyle。确保选中Checkstyleactive
for this project复选框(位置1)。
还可以指定要用于此项目的规则集(位置2),Eclipse的Checkstyle插件提供了两个规则集:Sun
Java编码标准以及对Sun规则略做修改的版本。后者更适合标准Eclipse格式约定。
Checkstyle代码检查可能很耗时,尤其是在检查大量文件时。过多的错误还可能使用户更难将精力集中在真正需要纠正的问题上。Exclude
from checking…(位置3)选项可以过滤掉不需要进行检查的特定类或软件包。
-
查看检查结果,并更正错误
Checkstyle检查完成之后,可以在Problems视图窗格中看见一长串违反规则的警告情况。
单击列表中的问题,将自动跳转到违反规则的代码段。违反规则的代码以黄色突出显示,另外在边上还有相应的标记。
-
在Eclipse中定制Checkstyle规则
实施通过配置文件提供的现成的Sun编码标准有时可能让人不知所措,Checkstyle可能会指出数以百计的相对小的规则违反情况,尤其是在没有使用Checkstyle时已经编写了大量代码的情况下。
要以最佳实践方式采用编码标准,并用Checkstyle来实施编码标准,通常需要彩种灵活的方式。这样做的最简单的方式是创建一组自定义编码标准,这些标准专门为公司或单位项目设计。
-
Eclipse的Windows->Preference->Checkstyle首选项。将会看见一些内置的配置文件。
-
需要创建新的Checkstyle配置文件,只需要单击New按钮,有多种配置文件可供使用,包括:
内置配置(Built-inconfiturations):例如Sun标准编码,它们由Checkstyle插件提供,并且不能更改。
内部配置(Internal configurations):存储在Eclipse元数据中。这些配置对于在本地实验新的配置很有用,但不方便与其他团队成员共享它们。
外部配置(External configurations):从外部来源导入。可以从本地磁盘的外部文件中或web服务器导入外部配置,或者存储在Eclipse项目中的配置管理下。
项目相对配置(Project Relative configurations):当其他工具如Ant或Maven也要在构建过程中使用相应的Checkstyle配置文件时,此配置尤其有用。
-
新建规则后,双击新的规则。在对话框中选取相应的规则,并根据自己的需求进行更改。
相关推荐
在Eclipse当中安装CheckStyle插件非常方便,和安装findBugs除了URL有区别之外,其他的几乎完全一样。我们可以参照以下几个步骤进行(注意一下,eclipse版本不一样,可能安装插件的位置有所调整,但是安装方法都是...
Eclipse java code checkstyle
checkStyle包里面提供了一套checkStyle的安装包,直接按照规则复制到eclipse目录就好了,配置有word文档截图说明,通俗易懂、操作简单,为我们更好的开发搭建基础。
checkstyle 6.4 for eclipse/eclipse 插件 checkstyle 6.4版本下载
eclipse中如何配置checkstyle进行代码检查,包中包含插件,同时附有检查结果说明。
主要介绍Eclipse中Checkstyle的配置。关于Checkstyle,引用百度百科的介绍如下:CheckStyle是 SourceForge下的一个项目,提供了一个帮助JAVA开发人员遵守某些编码规范的工具。它能够自动化代码规范检查过程,从而...
eclipse_checkstyle代码规范安装,eclipse_checkstyle代码规范安装
checkstyle 6.10 for eclipse/eclipse 插件 checkstyle 6.10版本下载
Eclipse的CheckStyle配置,实践经验建议配置。
checkstyle 6.2 for eclipse/eclipse 插件 checkstyle 6.2版本下载
追求卓越的代码人必备插件.用于检查代码规范。
使用Checkstyle Eclipse插件,可以不断检查您的代码是否存在编码标准差。 在Eclipse工作台中,您会通过Eclipse Problems View和类似于编译器错误或警告的源代码注释立即收到有关问题的通知。 这样可以确保开发人员...
CheckStyle是SourceForge下的一个项目,提供了一个帮助Java开发人员遵守某些编码规范的工具。它能够自动化代码规范检查过程,从而使得开发人员从这项重要但枯燥的任务中解脱出来。它可以根据设置好的编码规则来检查...
文件 附带插件安装包. 插件安装包下载时间2018-11-12日 离线安装.免去在线安装的网络烦恼.. 离线安装的方法通用于其他插件安装
Eclipse插件之Checkstyle/PMD/Findbugs(官方下载路径)
eclipse插件checkstyle 检查代码的好帮手
eclipse 集成 checkStyle 插件
在eclipse中修改checkstyle和pmd规则集的方法
NULL 博文链接:https://ysj5125094.iteye.com/blog/848113
由于在eclipse里安装checkstyle 输入链接经常报错,所以整了一个离线包,内含checkstyle的检查方式,也可以自己编辑