打开IDEA,选择Preferences - Plugins - Browse repositories后,在输入框中输入"alibaba",可以看到返回结果中有"Alibaba Java Coding Guidelines"。点击插件详情中的"install"按钮,按照其提示即可完成安装,安装完成后需重启IDEA。
-
在项目目录上右键(或者在工程目录上右键)点击也会出现下图所示的两个功能菜单,点击"编码规约扫描"的菜单项即可开始扫描代码:
在进行编码时会实时监测,如果觉得该功能太过于干扰工作,可以选择“关闭实时检测功能”。 扫描完成后,我们可以看到下方代码按照Blocker、Critical、Major三个等级显示了不符合规约的代码,当然这个规范是过于严格的,不一定要全部参照,在没有大的隐患的情况下,可不必完全准守,只是给我们提供了参考意见:
左边是扫描出的不符合规范的代码,依次点进去可以看到是代码的多少行出现了规约问题以及哪一个规约问题,右边则是规约的详细描述及实例代码。不仅如此,右侧还有quick fix的按钮,点击后直接可以自动完成修复,但是并不是所有的问题都有此按钮,有些问题还是需要手动修改。
-
如果不想全部扫描,只扫描当前编辑的文件的话,在当前文件面板中点击右键也会出现此功能按钮。
-
Alibaba Java Coding Guidelines插件也提供了实时监测的功能,此功能默认开启,一旦开启则会在你编写代码时就会实时监测,一旦有不符合规范的语句就会出现错误提示。比如,由于行尾注释的问题,下面代码会有灰色的波浪线提示:
idea中有quick fix快捷键:option/alt+enter,点击后则可以自动修正: