关于Java开发过程中质量提升-1代码格式配置

在项目开发维护中，编码规范作为开发规范的一个组成部分，是十分重要和必须的，它不仅仅是为了提高开发效率，也有利于降低后期维护开发的成本。编码规范的根本目的就是要让不仅代码可以一目了然，也可以很容易的理解开发人员所编写的代码程的用途和意义。由此，用来减少项目中因为开发维护人员的更替或由于长时间不维护造成的记忆模糊或混乱等情况带来的对代码所实现的真正功能的理解困难和歧义。另外也提高了代码复查效率和效果。

第一章Eclipse配置

1.1 codeformat和codetemplates导入

模板导入操作如下，codeformat：

1、  打开eclipse，选择windows->preferences->java->Code Style->Formatter

2、  选择Import…，然后选择codeformat.xml文件，

3、  最后选择apply，codetemplates操作也同样操作即可。

1.2 checkstyle

checksyle需要先安装eclipse插件，具体操作如下：

1、  打开eclipse，选择help->eclipse Marketplace，然后搜索checkstyle安装即可；

2、  完成安装重启eclipse后，选择windows->preferences->Checkstyle

3、  最后选中刚刚导入的这条数据，“set as Default”就设置完成了

第二章使用

2.1 codeformat和codetemplates

1、 codeformat模板导入完成后，直接在打开的文件中使用“shift+ctrl+f”快捷键就可以格式化代码格式了。如果不生效，肯定是快捷键被其他程序占用了，我电脑上就是被sogou输入法占用，去掉输入法中的快捷键就行了。

2、 codetemplates导入完成后，直接在类的声明处、方法声明处敲入“/**”，然后敲“回车”，就自动生成了注释模板格式。

2.2checkstyle

1、 选中项目工程，右键选择Checkstyle->Check Code with Checkstyle，就会自动检查项目样式，也可以选中某个已经打开的文件做此操作

2、 同样的操作，选择Clear Checkstyle violations取消检查。

3、 检查完成后，打开文件就会提示不合规项（鼠标放在行号边上的放大镜上或者提示的这行代码上，就可以看到详细描述），修改后再重新检查即可。

另外还可以配合SonarQube使用，后面文章将会介绍。