checkstyle 使用

Checkstyle

　　CheckStyle是SourceForge下的一个项目，提供了一个帮助JAVA开发人员遵守某些编码规范的工具。它能够自动化代码规范检查过程，从而使得开发人员从这项重要，但是枯燥的任务中解脱出来。 CheckStyle检验的主要内容 　　

·Javadoc注释 　　

·命名约定 　　

·标题 　　

·Import语句 　　

·体积大小 　　

·空白 　　

·修饰符 　　

·块 　　

·代码问题 　　

·类设计 　　

·混合检查（包括一些有用的比如非必须的System.out和printstackTrace） 　　

从上面可以看出，CheckStyle提供了大部分功能都是对于代码规范的检查，而没有提供象PMD和Jalopy那么多的增强代码质量和修改代码的功能。但是，对于团队开发，尤其是强调代码规范的公司来说，它的功能已经足够强大。

 

CheckStyle安装配置

在Eclipse当中安装CheckStyle插件非常方便,我们可以参照以下五个步骤进行:

1 在Eclipse当中分别打开一下菜单 Help->Software Updates->Find and Install
2 选择 Search for new features to install 选项然后点击 Next

3 新建一个 New Remote Site...
4 输入名称(比如:Checkstyle Plug-in) 和下面的的 URL: http://eclipse-cs.sourceforge.net/update
5 开始安装

6 配置CheckStyle: Windows ==> perference ==> checkstyle 配置的导入/导出就在配置界面右侧

 

结论

我们可以利用CheckStyle可以方便的对于编码的Code Conventions进行检查，同时，也有效地减少了Code Review的工作，使得开发人员的精力更多的集中到逻辑和性能检查。同时, 修改、定型CheckStyle的配置文件：按照基本配置文件执行一段时间（2～3周），听取开发人员的反馈意见，修改配置信息.

 

Code Review

就是审查代码的质量。根据形式分为两种，一种是交叉代码审查，就是自己的代码由他人来检查，就象检查作业一样；另一种是代码会审，就是以会议的形式，大家共同审核代码的质量。
1 Code Review 的目的
   在项目早期就能够发现代码中的BUG ；
   帮助初级开发人员学习高级开发人员的经验，达到知识共享；
   避免开发人员犯一些很常见，很普通的错误；

   保证项目组人员的良好沟通；

   项目或产品的代码更容易维护。
2 一般情况下，Code Review的内容与层次如下
   编码风格与代码规范一致性：检查代码是否符合编码规范，确保所有人写的代码基本一致；
   代码满足基本的功能要求：检查代码的逻辑实现，以及单元测试的编写策略，确认实现功能性需求；
   代码满足性能等非功能性需求：非功能性需求一般不便于测试，需要借助一定的工具和Review人员的素质

        ，针对编码中对于性能影响的瓶颈给出解决方案去除冗余，

   提高代码可读性：适当使用 Refactorying技术，去除代码中的Bad Smell