规范化之路(一) Checkstyle插件安装使用

随着代码越来越多,是时候对自己的代码进行规范化了

Checkstyle插件安装

1.离线包下载地址
https://sourceforge.net/projects/eclipse-cs/
或可以在csdn下载(123456, 版本号: 8.7.0.201801131309)
解压后直接放到dropins文件夹即可

2.在线安装
Help --> Install New Software
http://eclipse-cs.sourceforge.net/update

3.项目激活CheckStyle
右键项目 --> Checkstyle -->  Activate Checkstyle

 

注意: Checkstyle是一个编码规范工具,结合eclipse的格式化,可以基本保持一定的统一风格,但是光靠这些还不够,需要平时积累编码规范,形成统一编码风格,达到所有人写的代码都像是一个人写出来一样.

使用总结:

(一).使用后,默认使用Google的Checkstyle规范,Google的缩进规范是2个空格,因此需要修改formatter,让eclipse的Ctrl+Shift+F格式化时使用2个空格(默认是tab的4位),这里要修改的不只是java的formatter,xml的需要的话也需要修改,我在使用lo4j2.xml格式化时Checkstyle就会报格式不正确,具体要修改可根据实际情况,如下图

 

(二).关于import的包顺序问题,Google的规范是按a-z字母顺序排序的,所以在eclipse进行Checkstyle格式化的时候,也会报代码不符合规范,因为eclipse的排序规则是先把Window->Preferences->Java->Code->Style->Organize Imports里的排在import前面,然后再按a-z排序,因此为了符合Google规范,最后把Organize Imports的所有项都移除,才不报不符合规范的提醒.

(三).一些异常提示及解决

1.<p> 标签应在第一个字符之前，紧邻后者，之间不允许有空格。

这是在获取json官网的java包,放到项目,提示的,原因是注释里面只有<p>标签,而没有</p>结束标签导致的提示,加上即可.

2.Javadoc 第 0 个字符解析错误。解析 JAVADOC_TAG ，详情： no viable alternative at input ' *'

这是因为@throws前面没有空行,加上空行即可.

3.