如何在Java IDEA中安装阿里P3C以及使用说明

 1 关于阿里p3c

1.1.说明

代码规范检查插件P3C，是根据《阿里巴巴Java开发手册》转化而成的自动化插件。

1.2.什么是p3c插件

P3C原是海上途海上巡逻机的型号。被用来执行侦察、反潜、反水面、监视巡逻等海上任务。代码的世界里专治新手小毛病、老油条的各种不服。

1.3.p3c的作用是什么

为了让开发者更加方便、快速的将规范推动并实行起来，阿里巴巴基于手册内容，研发了一套自动化的IDE检测插件（IDEA、Eclipse）， 该插件在扫描代码后，将不符合《手册》的代码按Blocker/Critical/Major三个等级显示在下方，甚至在IDEA上，还基于Inspection机制提供了实时检测功能，编写代码的同时也能快速发现问题所在。对于历史代码，部分规则实现了批量一键修复的功能，提升代码质量，提高团队研发效能。

2 如何在IDEA中安装p3c

2.1打开IDEA

File-> Setteings->Plugins,输入alibaba，本地没搜到，就可以点击Search in repositories，搜到Alibaba Java Coding Guidelines后选择Install进行安装即可，安装后需restart(重启)IDEA。

 2.2使用安装好的插件

安装好了，使用方法是：打开IDEA，点击tools—>安装的阿里编码规约，可以选择中英文切换，项目右键选择编码规约扫描就可以进行查看自己编码哪些地方不够好，可以快速定位进行修改。

3 如何使用p3c插件检查代码

在需要检查的class类那儿单击鼠标右键，点击编码规约扫描选项即可

 3.1创建类时自动生成注释

由于阿里对旗下员工有极高的要求，每个类都需要注释作者。所以我们可以在File—>Settings—>Editor—>File and Code Templates——>Includes---->File Header

 于是在新建类后就会生成

大家就可以看到

 

 在File—>Settings—>Editor—>File and Code Templates—>File—>Class中也是一样的

也是一样的效果喔

 所有的抽象方法（包括接口中的方法）必须要用javadoc注释、除了返回值、参数、异常说明外，还必须指出该方法做什么事情，实现什么功能