CheckStyle 简记

CheckStyle

是一个很针对于java语言的代码规范检查工具,默认的情况下,遵循Google的Java编码规范和Sun编码规范,同时它可以自己配置,这就为在不同的团队可以根据自身的情况对检查规则进行裁剪或者新增,

Gradle 方式

根据CheckStyle 的官方文档进行检查规则的配置,主要有两个配置文件,

  • checkstyle.xml 检查规则配置文件
  • suppressions.xml 工程中某些特殊文件不需要检查的可以在这个文件中进行配置

直接介绍在AS 中插件的使用
打开AS 的Preferences 面板 ,选择其中的Plugins 选项,搜索CheckStyle
CheckStyle 简记

重启AS

CheckStyle 检验的主要内容

  1. Javadoc 注释
  2. 命名的约定
  3. 标题
  4. import 语句
  5. 体积大小
  6. 空白
  7. 修饰符
  8. 代码问题
  9. 类设计
  10. 混合检查