[置顶] 玩转Eclipse — 自动代码规范检查工具Checkstyle

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

1. 安装Checkstyle插件

        Eclipse菜单栏上选择 Help -> Install New Software...，进入如下安装界面：

        点击“Add...”打开Add Repository对话框，如图输入Name和Location，点击“OK”。
        选择刚刚添加的JAutodoc，一直点击“Next >”直到安装结束。

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检查之后，不符合规范的代码，底色都会被标记为浅黄色进行提示。点击行头的提示标记，就会显示具体不符合规范的地方。示例如下图所示：

Reference

        Checkstyle官网

        Checkstyle的Eclipse插件官网