在idea中使用CheckStyle来规范代码

 

CheckStyle是SourceForge下的一个项目，提供了一个帮助JAVA开发人员遵守某些编码规范的工具。它能够自动化代码规范检查过程，从而使得开发人员从这项重要，但是枯燥的任务中解脱出来。

idea版（版本：２０１８.２）

在idea中集成CheckStyle

File->Setting->Plugins至下图界面，搜索CheckStyle-IDEA，点击安装。

在idea中使用CheckStyle

第一步，使CheckStyle在idea中生效

settings->Editor->Inspections

第二步，添加配置文件，即为CheckStyle配置检测的规范，设定需要的代码规范

以下是配置文件的一个样本：

步骤：首先在本地新建一个XML文件，将上面的代码保存到XML文件中，打开
settings->CheckStyle，如下图，点击＋

在弹出的小窗口中选择我们刚才保存到本地的配置文件

点击Next后点击Finsh，完成配置。

• CheckStyle检验的主要内容
• Javadoc注释
• 命名约定
• 标题
• Import语句
• 体积大小
• 空白
• 修饰符
• 块
• 代码问题
• 类设计
• 混合检查（包括一些有用的比如非必须的System.out和printstackTrace）

第三步，测试我们配置的CheckStyle是否生效

首先，选择我们配置的规则

然后创建一段不怎么符合规范的代码

public class TestCheck {

    public void Mytest(){
        System.out.println("这是一个不符合命名规范的方法");
    }
}

然后右击选择Cｈｅｃｋ　Ｃｕｒｒｅｎｔ　Ｆｉｌｅ

点击之后，我们可以看到，ＣｈｅｃｋＳｔｙｌｅ帮我们指出了代码中的不规范