阿里p3c

一、引言

1.1 说明

阿里p3c含义是先进、检测、发现潜在问题的意思。

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

1.2 教学编排

按照如下顺序进行讲解，学习者可以先阅读阿里巴巴Java手册，了解编码规范；接着可以按公司需要安装eclipse或idea插件，对格式和编码进行自动检查；最后有兴趣的情况下，可以阅读插件源码，便于理解思想和进行二次开发。

• 阿里巴巴Java开发手册：阿里p3c是由《阿里巴巴Java开发手册》代码化而来，所以我们首先提供《阿里巴巴Java开发手册》下载和介绍，方便用户了解开发规范；
• 源码：接着我们给出p3c的源码地址和介绍，该p3c源码主要是eclipse、idea等开发工具所使用插件的源码以及教程，可以根据自身需求进行二次开发；
• idea：主要包括代码格式规范文件和idea扩展插件，用于.java文件代码格式化；idea插件，用于检查不符合阿里巴巴Java开发手册规范的代码；
• eclipse：主要包括代码格式规范文件，用于.java文件代码格式化；eclipse插件，用于检查不符合阿里巴巴Java开发手册的规范；

 

二、阿里巴巴Java开发手册

阿里巴巴Java开发手册(嵩山版).pdf

 

三、源码

Github P3C仓库地址

 

四、idea

4.1 idea插件

安装

打开Setting >> Plugins >> Browse repositories

使用

4.2 代码格式化样式

下载

【p3c-formatter】：【https://github.com/alibaba/p3c/tree/master/p3c-formatter】

安装支持eclipse代码格式化插件

导入代码格式化样式文件

4.3 代码模板格式化

IDEA不支持eclipse注释格式化文件，可以使用IDEA自带默认注释或者手动编辑注释模板。

 

五、eclipse

5.1 eclipse插件

eclipse官方插件教程

安装

1.点击Help >> Install New Software。

2.接着输入Update Site地址：https://p3c.alibaba.com/plugin/eclipse/update回车，，然后勾选Ali-CodeAnalysis。

3.按照按照向导Next操作，在安装成功后重新启动Eclipse以生效。

使用

1.选择语言

2.代码分析

5.2 代码格式化样式

下载

【p3c-formatter】：【https://github.com/alibaba/p3c/tree/master/p3c-formatter】

安装

5.3 代码注释模板格式化

下载

【p3c-formatter】：【https://github.com/alibaba/p3c/tree/master/p3c-formatter】

安装