阿里巴巴java开发规范Idea插件使用手册

插件官方下载地址:

https://plugins.jetbrains.com/plugin/10046-alibaba-java-coding-guidelines/versions

插件包是下载的最新版本(下载日期2020-04-28),大家可以直接使用(版本会在官网定期更新,大家可以关注,如果有更新版本下载后,替换原有插件即可。)

1.安装插件

插件安装可以在线安装(需要链接互联网)和下载后离线安装,这我把插件已经下载下来,直接介绍离线安装方式,见下图:

把插件包p3c-idea-2.0.2.zip放到本地目录下,这个目录记住,在安装的时候需要选择这个目录下的插件包。

阿里巴巴java开发规范Idea插件使用手册

阿里巴巴java开发规范Idea插件使用手册阿里巴巴java开发规范Idea插件使用手册

重启后,这个插件就已经安装完成啦!

2.使用方法

  • 扫描代码

     类级别扫描

该方法对存量代码进行扫描,会在下面生成扫描报告

 

阿里巴巴java开发规范Idea插件使用手册

阿里巴巴java开发规范Idea插件使用手册

工程范围内扫描

在工程上“右击”,在快捷菜单中选择“编码规则扫描”

阿里巴巴java开发规范Idea插件使用手册

在类级别扫描

在类上“右击”,在快捷菜单中选择“编码规则扫描”

阿里巴巴java开发规范Idea插件使用手册

重跑规范

修复完成后,重新跑规范

阿里巴巴java开发规范Idea插件使用手册

关闭实时扫描功能

插件在编码过程中会实时扫描代码是否符合阿里java开发规范(强烈推荐打开),如果不想打开,则可以如下方式关闭:

在编辑框内部“右击”,在弹出快捷菜单选择“关闭实时监测功能”

阿里巴巴java开发规范Idea插件使用手册

打开实时扫描功能

在编辑框内部“右击”,在弹出快捷菜单选择“打开实时监测功能”

阿里巴巴java开发规范Idea插件使用手册

 

定位不规则代码样例

在扫描出来结果后,在结果上“单击”,即可定位到不规的的代码块,并且有详细的提示信息,根据提示信息进行修改即可,插件中的规则基本涵盖了java开发规范中描述的规则,比如:我在代码中编写了:末尾注释方法名第一个字符大写的不规则代码

阿里巴巴java开发规范Idea插件使用手册阿里巴巴java开发规范Idea插件使用手册

设置扫描范围

插件中还能够进行设置扫描哪些代码(建议默认设置即可)

阿里巴巴java开发规范Idea插件使用手册

3.插件更新

插件分为在线更新和离线更新,在线更新(链接互联网)

离线更新

卸载已有插件

阿里巴巴java开发规范Idea插件使用手册

卸载完成后,在按照 安装插件的步骤即可

阿里巴巴java开发规范Idea插件使用手册

在线更新(连接互联网)

阿里巴巴java开发规范Idea插件使用手册