Alibaba Java Coding Guidelines 代码规范检查工具

前言：工欲善其事必先利其器，为了让自己写出易读性更高的代码，为了让团队代码风格尽量统一易于维护，有一套可执行的代码规范是再好不过了。其实市场上早已经有了很多代码规范扫描工具,比如之前我常用一款国外的代码质量管理工具SonarLint就能检测代码质量，让我开发过程中减少很多不必要的小错误。不过我最近偶然间看到阿里出品的一款代码规范检查工具Alibaba Java Coding Guidelines ，也可以作为IDEA的插件直接集成。我通过使用对比,发现阿里的Alibaba Java Coding Guidelines更加的强大, 在代码规范, 错误率,分析详细点上,比国外的 sonar 做的更好, 而且有时还支持批量修复代码明显更加的方便。所以强烈推荐给大家使用！！！

1、IntelliJ IDEA安装Alibaba Java Coding Guidelines 代码规范检查插件

打开IDEA，选择File—Settings—plugings，搜索Alibaba找到这款插件安装即可

2.重启IDEA，开始使用

我们可以在项目位点击右键，最下面就有编码规范扫描和打开实时监测功能，当然点击菜单栏Toos里面的阿里编码规范也可以，这样扫描检测的就是整个项目。

选中某一个类，或者在这个类里边右键也可以，这样检测的就是此类

注意：在项目位置点击编码规范检测是检测整个项目，而在类上点击只是扫描这个类。

3.扫描出坏代码

扫描代码后，将不符合规约的代码按 Blocker/Critical/Major 三个等级显示在下方，双击可以定位至代码处，右侧窗口还有针对代码的批量修复功能。

解释下Blocker/Critical/Major三个等级，在 Snoar 中对代码规则有五个级别，这是前三个：崩溃/严重/重要 ，也就是说前两级别是必须要处理掉的。

不扫不知道，一扫吓一跳，以前不以为然的写法，都会在这暴露无疑，重点是对于有线程安全问题的代码他也会提示。这很重要！！！还有要特别注意的是，Major等级里面提示我们必须按照javdoc文档的规范注释，这也很重要，因为我们用IntelliJ IDEA编辑好Java项目以后，一般需要生成一个JavaDoc文档供相关人员阅读。而JavaDoc是一种利用注释生成HTML文档的技术，生成的HTML文档类似于Java的API，易读且清晰明了。以后我再也不会行尾注释啦，按照javadoc文档规范来！！！

4、javadoc文档简介（补充知识可选）

javadoc是Sun公司提供的一个技术，它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说，只要在编写程序时以一套特定的标签作注释，在程序编写完成后，通过Javadoc就可以同时形成程序的开发文档。生成的HTML文档类似于Java的API，易读且清晰明了。

因为我们用IntelliJ IDEA编辑好Java项目以后，一般需要生成一个JavaDoc文档供相关人员阅读。所以，我们可以了解一下在Intellij Idea 中如何将代码中的注释生成HTML文档：

4.1Java源文件

4.2菜单栏Tools选择Generate JavaDoc...

4.3简单设置一下就ok了，注意生成的javadoc的html文档会有很多，建议建一个新文件夹装它们

4.4创建成功，效果和我们常看的API帮助文档差不多

创建完毕，IDEA会自动帮我们打开index.html

javdoc文档技术参考链接：

如何使用Intellij Idea生成JavaDoc文档

Intellij IDEA如何生成JavaDoc