图解Eclipse优化Checkstyle静态分析工具

一 安装Checkstyle插件

二 优化模板文件

1 复制一份作为要优化的文件

2 下面是复制后的结果

3 设置为默认项

 

4 开始配置

5 选择优化项

6 开始优化

三 导出模板文件

四 导入模板文件

1 新建一个模板

2 导入前面导出的模板

3 导出后的样子

五 优化举例

1.javadoc Comments
  Style Javadoc
  checkFirstSentence:去掉对号（第一句话结尾符号的检查）
2.SizeViolations
  Maximun Line Length：80换成120
3.SizeViolations
  Maximun method Length：countEmpty 去掉打钩（150行不算空白行）
4.Coding Problem
  Hidden Field ：去掉对号，变成ignore（变量间不存在隐藏）
5.Class Design
  Design For Extension：去掉对号，变成ignore(检查类是否为扩展设计，否则类就应被设计成abstract final empty)
6.Class Design：
  Hide Utility Class Constructor：去掉对号，变成ignore(检查类是否为通用类的判断标准是——是否含有public static方法：
  如果为通用类，那么就不能够有public的构造方法或者默认的构造方法)
7.Miscellaneous
  Final Parameters:去掉对号，变成ignore（参数没有必要都设置成final）
8.Miscellaneous
  New Line At End Of File:去掉对号，变成ignore（在文件末尾增加一个新的行）
  特别说明：集成环境里提供的Formatter文件，默认设置在末尾不需要增加一行，而Checkstyle默认检查规则需要增加一行。
  关于是否需要增加一行，我们推荐不需要增加一行。如果习惯增加一行，就都增加一行，只要两者统一即可。
  这就如同一行要规定多少文字改行一样，我们推荐120文字（最佳实践），但是设定150或者160等其他数字也可以，只要统一且方便阅读。