阿里代碼規範插件 中文使用手冊 FOR Eclipse

首先很是感謝你們對插件的支持與意見，Eclipse的功能相對來講比較簡單，但願有更多的同窗加入進來一塊兒完善。

插件安裝

環境：JDK1.8，Eclipse4+。有同窗遇到過這樣的狀況，安裝插件重啓後，發現沒有對應的菜單項，從日誌上也看不到相關的異常信息，最後把JDK從1.6升級到1.8解決問題。

Help -> Install New Software...

輸入Update Site地址：https://p3c.alibaba.com/plugin/eclipse/update 回車，而後勾選Ali-CodeAnalysis，再一直點Next Next...按提示走下去就好。 而後就是提示重啓了，安裝完畢。

注意：有同窗反映插件掃描會觸發不少 "JPA Java Change Event Handler (Waiting)" 的任務，這個是Eclipse的一個bug，由於插件在掃描的時候會對文件進行標記，因此觸發了JPA的任務。卸載JPA插件，或者嘗試升級到最新版的Eclipse。附：JPA project Change Event Handler問題解決

插件使用

目前插件實現了開發手冊中的53條規則，大部分基於PMD實現，其中有4條規則基於Eclipse實現，支持4條規則的QuickFix功能。

* 全部的覆寫方法，必須加@Override註解， 
* if/for/while/switch/do等保留字與左右括號之間都必須加空格,
* long或者Long初始賦值時，必須使用大寫的L，不能是小寫的l）
* Object的equals方法容易拋空指針異常，應使用常量或肯定有值的對象來調用equals。

目前不支持代碼實時檢測，須要手動觸發，但願更多的人加入進來一塊兒把我們的插件作得愈來愈好，儘可能提高研發的使用體驗。

代碼掃描

能夠經過右鍵菜單、Toolbar按鈕兩種方式手動觸發代碼檢測。同時結果面板中能夠對部分實現了QuickFix功能的規則進行快速修復。

觸發掃描

在當前編輯的文件中點擊右鍵，能夠在彈出的菜單中觸發對該文件的檢測。

在左側的Project目錄樹種點擊右鍵，能夠觸發對整個工程或者選擇的某個目錄、文件進行檢測。

也能夠經過Toolbar中的按鈕來觸發檢測，目前Toolbar的按鈕觸發的檢測範圍與您IDE當時的焦點有關，如當前編輯的文件或者是Project目錄樹選中的項，是否是感受與右鍵菜單的檢測範圍相似呢。

掃描結果

簡潔的結果面板，按規則等級分類，等級->規則->文件->違規項。同時還提供一個查看規則詳情的界面。

清除結果標記更方便，支持上面提到的4條規則QuickFix。

查看全部規則

 

國際化