Java-idea-Checkstyle自动化代码规范检查-白红宇

Java-idea-Checkstyle自动化代码规范检查

阅读量：6006 次

发布时间：2019-06-20

本文共 4372 字，大约阅读时间需要 14 分钟。

一、概述

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

　　CheckStyle检验的主要内容

　　　　·Javadoc注释

　　　　·命名约定

　　　　·标题

　　　　·Import语句

　　　　·体积大小

　　　　·空白

　　　　·修饰符

　　　　·块

　　　　·代码问题

　　　　·类设计

　　　　·混合检查（包括一些有用的比如非必须的System.out和printstackTrace）

　　从上面可以看出，CheckStyle提供了大部分功能都是对于代码规范的检查，而没有提供象PMD和Jalopy那么多的增强代码质量和修改代码的功能。但是，对于团队开发，尤其是强调代码规范的公司来说，它的功能已经足够强大。

　　地址：http://checkstyle.sourceforge.net/

　　1、安装

　　　　File→setting→plugins→checkstyle

　　　　安装即可

　　2、配置idea_checks.xml

　　　　File→setting→Other Settings→checkstyle

　　　　此时默认有一个sun_check.xml

　　　　Checkstyle默认的设置就是sun_checks.xml配置文件,一般Sun Checks的检查项限定得较为严格，我们实际项目中并不要求那么完美的编程规范，那么可以自己定义检查的配置文件，最后将Checkstyle的配置文件设定为我们自定义的文件即可。

　　自定义配置

　　　　xml文件，idea_checks.xml

View Code

　　　　添加选中即可

　　3、启用CheckStyle

　　　　File→setting→Editor→Inspections→选中checkstyle

　　4、使用

　　　　在文件上右键，Check Current File即可

转载地址：http://tasmx.baihongyu.com/

你可能感兴趣的文章