CheckStyle是 SourceForge下的一个项目,提供了一个帮助JAVA开发人员遵守某些编码规范的工具,可以帮助程序员编写一个符合编码标准的Java代码。
CheckStyle 项目主页:http://checkstyle.sourceforge.net/
CheckStyle 优点:
- Checkstyle提供了高可配置性,可支持几乎所有编码标准,以便适用于各种代码规范,
- 默认情况下它支持Sun代码约定,同时它也可以与一个Ant任务和命令行程序来调用。
- 它可以自动有效的帮助我们检视代码以便更好的遵循代码编写标准,这使得它非常适合那些希望实施编码标准的项目。
- 最终要的是,它的诞生可以使得程序猿从代码检查这个无聊但又很重要的的任务中解脱出来,帮助程序猿节省出宝贵的时间做更多有价值的事情。
CheckStyle 检验的主要内容 :
-
Javadoc注释
-
命名约定
-
标题
-
Import语句
-
体积大小
-
空白
-
修饰符
-
块
-
代码问题
-
类设计
-
混合检查(包括一些有用的比如非必须的System.out和printstackTrace)
从上面可以看出,CheckStyle提供了大部分功能都是对于代码规范的检查,而没有提供象PMD和Jalopy那么多的增强代码质量和修改代码的功能。但是,对于团队开发,尤其是强调代码规范的公司来说,它的功能已经足够强大。
接下来, 就开始我们的 CheckStyle 之旅吧!