1.简介
Checkstyle是SourceForge下的一个开源项目,提供了一个帮助JAVA开发人员遵守某些编码规范的工具。它能进行自动化代码规范检查,从而使得开发人员从这项重要但又枯燥的任务中解脱开来。
Checkstyle具有高度可配置性,这使得它可以支持几乎所有的编程规范。
本文主要将介绍Eclipse中插件的使用方法。
2.安装
1)Eclipse自动安装地址
http://eclipse-cs.sf.net/update/
2)手动安装
--下载地址:http://sourceforge.net/projects/eclipse-cs/files/OldFiles/
--将下载包解压后的features和plugins目录中的文件复制到%ECLIPSE_HOME%下的对应目录中
--重启ECLIPSE
3.使用
--自动检查:
右键目标项目-->checkstyle-->Activate Checkstyle
--手动检查:
右键目标项目/目录/文件-->checkstyle-->Check Code With Checkstyle
--查看错误:
windows-->show view-->Checkstyle Violations
4.常见错误
--Package Javadoc: Missing package-info.java file.
缺少package-info.java文件
关于package-info.java:http://blog.csdn.net/antswallow/article/details/6277079
--New Line At End Of File: File does not end with a newline.
文件的最后一行不是以新行结尾的
--Type Javadoc: Missing a Javadoc comment.
缺少JAVADOC注释
--RegexpSingleline: Line has trailing spaces.
行以空白符结尾
--Style Javadoc: First sentence should end with a period.
第一句必须应该以"."结尾
--File Tab Character: File contains tab characters (this is the first instance).
包含有Tab符,替换Tab符合的方法:http://hi.baidu.com/lane727/blog/item/bd6304fb7cb48555242df27f.html
--Whitespace Around: '{' is not preceded with whitespace.
"{"之前没有空格
更多出错原因查找:http://checkstyle.sourceforge.net/availablechecks.html
5.参考资料