编码规范系列(二):Eclipse Checkstyle配置

http://chenzhou123520.iteye.com/blog/1627618

上一篇介绍了《编码规范系列(一):Eclipse Code Templates设置》,这篇主要介绍Eclipse中Checkstyle的配置。关于Checkstyle,引用百度百科的介绍如下:CheckStyle是SourceForge下的一个项目,提供了一个帮助JAVA开发人员遵守某些编码规范的工具。它能够自动化代码规范检查过程,从而使得开发人员从这项重要,但是枯燥的任务中解脱出来。CheckStyle检验的主要内容包括:Javadoc注释、命名约定、标题、Import语句、体积大小、空白、修饰符、块、代码问题、类设计、混合检查。

如果我们想要使用Checkstyle,首先必须在Eclipse中安装Checkstyle插件,关于插件的安装教程网上到处都是,在这里就略过了。下面主要讲一下Checkstyle的配置。具体步骤如下:

1.在Eclipse中打开Windows-->Preferences-->Checkstyle,如下图所示:

通过界面我们可以发现,Checkstyle插件中默认内置有2个执行代码检查的配置文件:Sun Checks、Sun Checks(Eclipse)。这两个配置文件中分别定义了Checkstyle需要检查的选项配置。一般项目组都会根据项目需求自定义一个配置文件,然后通过import的方式导入到Eclipse中。今天,我们主要介绍这一种方式。

2.点击New,在弹出的界面中Type下拉框选择External Configuration File,然后引入我们自定义的配置检查xml文件,Name可以自定义,如下图所示:

点击OK保存,然后我们在前一个界面中就能看到我们刚刚导入的配置了。就是下图中的chenzhou_checkstyle

我们可以鼠标选中该行,然后点击右边的Set as Default按钮,这样Checkstyle就已经配置好了。

配置好了Checkstyle,我们还需要单独在项目中激活Checkstyle检查,具体方法为:

右键点击项目-->Properties-->Checkstyle,在弹出的界面中选中Checkstyle active for this project前的复选框,同时在Configure栏选中我们自定义的配置chenzhou_checkstyle,如下图所示

点击OK保存后项目会rebuild,这样Checkstyle检查就已经激活了。

我们可以打开我们的代码,如果代码中有不符合Checkstyle定义的规范的地方,Eclipse会黄色高亮显示,如下图所示:

如果我们把鼠标悬停在高亮代码上,Eclipse会给出提示警告信息。

对于Checkstyle检查选项的详细配置,我们可以在Eclipse中进行配置修改,如下图,选中chenzhou_checkstyle

点击右边的Configure按钮,弹出下面的界面

上图中,左边的菜单项代表我们可以进行配置的选项,每一个菜单项都可以展开为多个子菜单项。我们可以分别进行配置。其中菜单项上标了绿色对勾的表示该项以及所有子项已经添加到了检查项中。如果子项没有全部添加,则父菜单项不会显示绿色对勾。

如果我们需要添加某个配置项,可以点击选中某个菜单项,然后点击下方的Add按钮,选择OK后该项的子菜单项会显示在右边区域,我们可以通过勾选菜单项前的复选框对具体的项进行配置。如下图所示

对于具体的每一项的意思,就不一一细说了,应该大家应该都能看懂!

时间: 2024-08-05 06:49:42

编码规范系列(二):Eclipse Checkstyle配置的相关文章

编码规范系列(一):Eclipse Code Templates设置

http://chenzhou123520.iteye.com/blog/1625629 从工作开始,经历了几个项目的开发,现在的项目一般都是一个团队共同开发,而每个人都有自己的编码习惯,为了统一格式,项目组在项目开发之前都会制定一系列的规范.俗话说约定优于配置,但是在执行过程中往往发现效果不是很好(主要是指编码规范这一方面).所以我们不得不采取一些措施来协助我们统一项目开发人员的编码风格.主要包括三个方面:设置Code Templates.Eclipse formatter.Checkstyl

《编写可维护的JavaScript》——JavaScript编码规范(二)

昨天是我偶像生日,现在整个人都还好兴奋啊O(∩_∩)O~  闲话少说,让我先发篇随笔留念一下^_^ ////////////////////////////////正文分割线////////////////////////////////////// 命名 只要写代码,都会涉及变量和函数,因此变量和函数命名对增强代码可读性至关重要.JavaScript语言的核心ECMAScript,即是遵照了驼峰式大小写(Camel case)命名法.Camel case在这里被作者用来特指“小驼峰式大小写”(

CheckStyle,定制自己的Java编码规范

前言 一.CheckStyle简介 Checkstyle是一个开发工具,可以帮助程序员编写遵循编码标准的Java代码.它自动化了检查Java代码的过程,以避免人类完成这一枯燥(但很重要)的任务.这使得它非常适合那些希望实施编码标准的项目.Checkstyle是高度可配置的,可以支持几乎任何编码标准,默认内置Sun Java编码规范和Google Java编码规范两套配置文件,我们也可以根据自己的需要配置自己的规范. 二.CheckStyle的安装 与其它的插件一样,CheckStyle插件也提供

JAVA开发环境搭建 - Eclipse基本配置

Eclipse设置的内容包括许多方面,不同的开发人员,不同的项目需要,可能对Eclipse的设置不尽相同.如下内容仅是对本人的一些基本设置做一些记录,以作备忘.后期会逐渐对相关内容进行更新,仅供参考. 1. 下载Eclipse 网址: http://www.eclipse.org/downloads/ Eclipse分为不同版本,每个版本所针对的开发应用领域略有不同.有的适合 Web程序开发, 有些适合 插件 开发, 有些适合 桌面程序开发. 开发人员可以根据实际开发需要,下载不同的Eclips

FIG-PHP PSR规范系列1-基础编码规范

1. FIG-PHP与PSR简介 FIG-PHP制定了一系列PHP开发规范,简称PSR,这里FIG是框架互操作工作组(Framework Interoperability Group)的简称,PSR是PHP标准推荐(PHP Standard Recommendation)的缩写.FIG-PHP工作组最初是源于项目代表讨论两个项目之间的共性时,找出可以共事的方式.主要的受众是双方项目组,但PHP界的其他人也在观望.如果其他人愿意采用这里的规范,那么欢迎,但这并非工作组的目标.工作组中没人会告诉你如

Java Web学习(二) Eclipse的配置

Java Web学习(二) Eclipse的配置 一.下载Eclipse 1.进入Eclipse官网,进行下载 上图,下载Eclipse IDE for JaveEE Developers 版本,然后根据windows系统32位或64位,进行选择(建议64位).如果你的机器内存过小,可以选择Eclipse的旧版本:Eclipse Indigo .Eclipse Juno . Eclipse Kepler 等版本. 2.解压缩安装 打开压缩包,将里面的Eclipse 拖出到指定位置,进行解压缩.

Python + OpenCV2 系列:3 - python 字符串,类,编码规范

首先,强烈推荐<<简明 Python 教程>> Swaroop, C. H. 著 沈洁元 译 其实,这本书里已经把python的最基本的用法,编码等等介绍的很好,这里把我用到的进行一下总结. 1. 字符串 连接 字符串数组 转义字符 Excellent Reference Link :http://www.w3cschool.cc/python/python-strings.html 字符串 ● 使用单引号(')你可以用单引号指示字符串,就如同'Quote me on this'这

【CI】系列二:Ubuntu环境虚拟机安装及配置

好了,做好了初步计划之后,如果可行性没问题,就可以开始实践了. 准备前提:VirtualBox.ubunut镜像 如果没有,可以通过如下地址下载,安装过程此处不做描述. VirtualBox 4.3.12 for Windows hosts:http://download.virtualbox.org/virtualbox/4.3.12/VirtualBox-4.3.12-93733-Win.exe ubuntu-14.04-desktop-amd64.iso:http://mirrors.hu

[Java系列1]Eclipse配置,常用插件

java可视化编程-eclipse安装windowbuilder插件 http://blog.csdn.net/jason0539/article/details/21219043 [Java系列1]Eclipse配置,常用插件,码迷,mamicode.com