天天看點

阿裡p3c(代碼規範,eclipse插件、模版,idea插件)

阿裡p3c

一、說明

代碼規範檢查插件p3c,是根據《阿裡巴巴Java開發手冊》轉化而成的自動化插件。

(進階黑:P-3C“Orion”,反潛巡邏機,阿裡大概取p3c先進,監測,發現潛在問題的意思)

阿裡p3c(代碼規範,eclipse插件、模版,idea插件)
阿裡p3c(代碼規範,eclipse插件、模版,idea插件)

二、源碼位址

https://github.com/alibaba/p3c

下載下傳下來之後為:p3c-master檔案夾;

對于MAC電腦的mac ,我們使用:p3c-master/ideal-plugin/p3c-common;

導入到ideal中;如下圖所示;

核心代碼為:src/main/kotlin/com.alibaba/p3c.idea/這就是掃描的核心代碼

阿裡p3c(代碼規範,eclipse插件、模版,idea插件)

裡面的p3c-idea/src/main/resources/META-INF/p3c.xml就是配置;

比如  

<action class="com.alibaba.p3c.idea.action.AliInspectionAction" id="AliP3CInspectionAction"
                popup="true" text="編碼規約掃描" icon="P3cIcons.ANALYSIS_ACTION">
            <keyboard-shortcut keymap="$default"
                               first-keystroke="shift ctrl alt J"/>
            <add-to-group group-id="MainToolBar" anchor="last"/>
            <add-to-group group-id="ProjectViewPopupMenu" anchor="last"/>
            <add-to-group group-id="ChangesViewPopupMenu" anchor="last"/>
            <add-to-group group-id="EditorPopupMenu" anchor="last"/>
        </action>      

裡面的 ProjectViewPopupMenu 指的就是添加右鍵菜單;

阿裡巴巴Java開發手冊

《阿裡巴巴Java開發手冊》旨在碼出高效,碼出品質。

二、目的

标準化,正規化,高效協同。

三、下載下傳

阿裡巴巴Java開發手冊(詳盡版).pdf

阿裡代碼規範設定

一、eclipse

【https://www.eclipse.org/downloads/】

二、eclipse代碼規範

1. 下載下傳

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

阿裡p3c(代碼規範,eclipse插件、模版,idea插件)

2. 導入代碼格式化樣式

阿裡p3c(代碼規範,eclipse插件、模版,idea插件)

3. 導入代碼格式檔案

阿裡p3c(代碼規範,eclipse插件、模版,idea插件)

三、eclipse插件

【p3c-eclipse-plugin】:【https://p3c.alibaba.com/plugin/eclipse/update】

阿裡p3c(代碼規範,eclipse插件、模版,idea插件)

2. 将【features】及【plugins】複制到eclipse目錄,重新開機eclipse

3. 編寫測試檔案

阿裡p3c(代碼規範,eclipse插件、模版,idea插件)
/**
 * @author lsysy
 * @date 2018/11/13
 */
public class Test {
    public static void main(String[] args) {
        String Ba = "Ba";
        if ("Ba" == Ba) {
            System.out.println(Ba);
        }
    }
}      
阿裡p3c(代碼規範,eclipse插件、模版,idea插件)

4. 點選
阿裡p3c(代碼規範,eclipse插件、模版,idea插件)
進行阿裡編碼規約掃描(如果不可用,點選
阿裡p3c(代碼規範,eclipse插件、模版,idea插件)
切換語言,再切換回來,重新開機即可)

阿裡p3c(代碼規範,eclipse插件、模版,idea插件)

5. 可選(設定eclipse儲存時自動格式化)

阿裡p3c(代碼規範,eclipse插件、模版,idea插件)

四、idea

【https://blog.csdn.net/mashuai720/article/details/79389314】

五、idea插件

【p3c-idea-plugin】:【https://plugins.jetbrains.com/plugin/10046-alibaba-java-coding-guidelines】

阿裡p3c(代碼規範,eclipse插件、模版,idea插件)

【eclipse-code-formatter】:【https://plugins.jetbrains.com/plugin/6546-eclipse-code-formatter】

阿裡p3c(代碼規範,eclipse插件、模版,idea插件)

【save-actions-plugin】:【https://plugins.jetbrains.com/plugin/7642-save-actions】

阿裡p3c(代碼規範,eclipse插件、模版,idea插件)

2. 安裝

阿裡p3c(代碼規範,eclipse插件、模版,idea插件)

3. 使用

阿裡p3c(代碼規範,eclipse插件、模版,idea插件)

六、idea代碼規範

1. 準備

阿裡p3c(代碼規範,eclipse插件、模版,idea插件)

 FileHeader

2. 寫入檔案頭注釋

阿裡p3c(代碼規範,eclipse插件、模版,idea插件)

3. 導入代碼格式化樣式(導入eclipse-codestyle.xml)

阿裡p3c(代碼規範,eclipse插件、模版,idea插件)

4. 可選(設定idea儲存時自動格式化)

阿裡p3c(代碼規範,eclipse插件、模版,idea插件)

參考: 阿裡p3c(代碼規範,eclipse插件、模版,idea插件)