阿里代码规范插件 中文使用手册 FOR Eclipse

首先很是感谢你们对插件的支持与意见,Eclipse的功能相对来讲比较简单,但愿有更多的同窗加入进来一块儿完善。git

插件安装

环境:JDK1.8,Eclipse4+。有同窗遇到过这样的状况,安装插件重启后,发现没有对应的菜单项,从日志上也看不到相关的异常信息,最后把JDK从1.6升级到1.8解决问题。github

Help -> Install New Software...eclipse

输入Update Site地址:https://p3c.alibaba.com/plugin/eclipse/update 回车,而后勾选Ali-CodeAnalysis,再一直点Next Next...按提示走下去就好。 而后就是提示重启了,安装完毕。ide

注意:有同窗反映插件扫描会触发不少 "JPA Java Change Event Handler (Waiting)" 的任务,这个是Eclipse的一个bug,由于插件在扫描的时候会对文件进行标记,因此触发了JPA的任务。卸载JPA插件,或者尝试升级到最新版的Eclipse。附:JPA project Change Event Handler问题解决ui

插件使用

目前插件实现了开发手册中的53条规则,大部分基于PMD实现,其中有4条规则基于Eclipse实现,支持4条规则的QuickFix功能。spa

* 全部的覆写方法,必须加@Override注解, 
* if/for/while/switch/do等保留字与左右括号之间都必须加空格,
* long或者Long初始赋值时,必须使用大写的L,不能是小写的l)
* Object的equals方法容易抛空指针异常,应使用常量或肯定有值的对象来调用equals。

目前不支持代码实时检测,须要手动触发,但愿更多的人加入进来一块儿把我们的插件作得愈来愈好,尽可能提高研发的使用体验。.net

代码扫描

能够经过右键菜单、Toolbar按钮两种方式手动触发代码检测。同时结果面板中能够对部分实现了QuickFix功能的规则进行快速修复。插件

触发扫描

在当前编辑的文件中点击右键,能够在弹出的菜单中触发对该文件的检测。指针

在左侧的Project目录树种点击右键,能够触发对整个工程或者选择的某个目录、文件进行检测。日志

也能够经过Toolbar中的按钮来触发检测,目前Toolbar的按钮触发的检测范围与您IDE当时的焦点有关,如当前编辑的文件或者是Project目录树选中的项,是否是感受与右键菜单的检测范围相似呢。

扫描结果

简洁的结果面板,按规则等级分类,等级->规则->文件->违规项。同时还提供一个查看规则详情的界面。

清除结果标记更方便,支持上面提到的4条规则QuickFix。

查看全部规则

 

国际化

相关文章
相关标签/搜索