一般项目由多个人共同参与开发，但是每个人都有自己的编码习惯，甚至很多都是不正确的。那么如何使小组所有开发人员都遵循某些编码规范，以保证项目代码风格的一致性呢？如果硬性地要求每个开发人员在提交代码之前，都要对照的编码规范将自己的代码检查一遍，将是一个非常枯燥而且耗时的任务，在我们项目开发过程中应用了Checkstyle工具，感觉非常方便，特此记录下来供大家参考，Checkstyle是一个开源代码分析工具，能够帮助开发人员保证他们的代码遵循一定的代码规范。Checkstyle通过不断地检查你的代码，一旦发现有违反定义的代码规范的地方就立马提示，以便开发人员能够及时发现和修改不规范代码。Checkstyle在Eclipse中的插件是eclipse-cs。

1. 安装Checkstyle插件

Eclipse菜单栏上选择 Help -> Install New Software...，进入如下安装界面：点击“Add...”打开Add Repository对话框，如图输入Name和Location，点击“OK”，一直点击“Next >”直到安装结束。选中的压缩包网址：

https://ncu.dl.sourceforge.net/project/eclipse-cs/Eclipse%20Checkstyle%20Plug-in/8.0.0/net.sf.eclipsecs-updatesite_8.0.0.201707161819.zip

2. 配置Checkstyle

Eclipse菜单栏上选择 Window -> Preferences -> Checkstyle，进入如下设置界面：

在Global Check Configurations框中，列出可以选择的检查配置（Check Configuration），Default栏标记为对勾的默认配置。如果想自己配置检查选择，可以点击“New...”按钮新建一个配置，进入如下Check Configuration界面：

检查配置的类型，可以有多种选择。Internal Configuration类型是检查配置存在于Eclipse内部；External Configuration类型相当于导入一个已有的xml配置文件。Checkstyle配置都是xml文件。如果想修改已有的配置，可以点击“Configure...”按钮，打开Checkstyle Configuration对话框，根据需要进行修改。

3. 使用Checkstyle

Checkstyle会在代码开发过程中，不断地检查代码规范，一般检查的内容包括：

· Javadoc注释

· 命名约定

· 标题

· Import

· 大小

· 空白

· 修饰符

· 代码

· 类设计

安装成功后，选中工程，右键选择checkstyle->check code with checkstyle,检查错误即可。

此时，看看原文件的变化吧。原文件上会在不符合规范的地方出现黄颜色！号，鼠标停留在叹号处，可以看到信息提示。或者，在Console控制台一栏，可以看到Checkstyle violations 的视图，里面会有信息提示。

选择Checksty violations chart视图,会把每种不规范的信息做下统计，绘制成图表。

使用Checkstyle检查整个项目

在项目名上，右击选择Checkstyle，选择Check Code with Checkstyle