Checkstyle是一种代码规范的检查工具,它可以通过检查源文件找到不符合规范的地方,以此来帮助开发者提高代码质量。
Codereview可以干吗?先来看下面这张图,这是我用自定义的规则扫描了java文件以后的结果,会发现有很多因为编码不规范而报错的地方(无javadoc,注释不符实,命名等等)。
Checkstyle可以进行检查编码规范,包括javadoc,命名规范等,但不只限于此。它还可以检查一个代码块的各种复杂度、代码块大小,魔法数等(具体可以参考手册)。
再介绍一下在eclipse中如何使用checksyle。安装了checkstyle后(http://eclipse-cs.sourceforge.net/update),在Preferences下会有Checkstyle的选项。在check Configurations下,添加自己定义的检查规则(默认的sun的检查太变态了…),并设置为默认的检查规则,如图:
设置为默认检查规则:
这样,就可以在需要检查的类上右键选择checkstyle检查了。再说明一下,不同版本的使用方法稍有不同,但都比较简单,可以自己琢磨下。
附上我自己使用的检查规则,有需要的可以参考下。