IDEA代碼規范插件P3C+代碼註釋模板配置方法

Posted on by

IDEA配置阿裡規范插件P3C

進入idea -》File -》 Settings -》Plugins

Plugins 搜索插件

到搜索框中搜索：Alibaba Java Coding Guidelines 下載安裝插件，安裝之後重啟IDEA ，進入你的編輯器右擊會發現多

瞭，檢查規范和關閉檢查。

使用規范檢查

檢查會發現你這個java文件是否存在問題並給出提示如：

規范提示

也常常遇到類是 class 或者方法上面缺少 javadoc註解 如：

  • 所有的類都必須添加創建者信息
  • 所有的抽象方法（包括接口中的方法）必須要用javadoc註釋、除瞭返回值、參數、異常說明外，還必須指出該方法做什麼事情，實現什麼功能。

通過添加java 類 、方法註釋模板來滿足這些需求

  • 開發工具 :IDEA
  • 代碼格式化模板 : 阿裡格式化模板
  • 註釋模板樣例
/**
 * 類模板樣例
 * Demo class (描述)
 * 
 * @author keriezhang
 * @date 2016/10/31 20:07
 */
 public class CodeNoteDemo {
 }
/**
 * 方法模板樣例
 * fetch data by rule id (描述)
 * 
 * @author keriezhang
 	 * @date 2016/10/31 20:07
 * @param ruleId rule id
 * @param page page number
 * @param jsonContext json format context
 * @return Result<XxxxDO>
 */
 Result<XxxxDO> fetchDataByRuleId(Long ruleId, Integer page, String jsonContext);

IDEA配置模板步驟

配置全局USERHelp->Edit Custom VM Options...配置全局USER，用於填充自動生成的註釋中的作者@author屬性。添加一行 -Duser.name=xxx （xxx為名稱）

全局中USER

配置類註釋模板 settings->Editor->File and Code Templates->files->class

添加class模板

增加註釋模板內容：

/**
 * ${description}
 * @author ${USER}
 * @date ${YEAR}/${MONTH}/${DAY} ${HOUR}:${MINUTE}
 **/

新創建java文件時，會提示輸入類描述description，生成的文件格式如下：

package tuan.press.test;

/**
 * 測試類
 * @author keriezhang
 * @date 2016/10/31 20:07
 **/
public class MyTests {
}

配置方法註釋 Editor->Live Template->java 新建Live Template，進行如下配置：

方法模板描述

第5步，適用場景配置如下：

添加java所以場景

第6步，模板變量配置如下：

在這裡插入圖片描述

配置參數

  • 縮寫Abbreviation：*
  • 模板Template text：
*
 * 
 * @author $user$
 * @date $data$ $time$$param$
 * @return $return$ 
 */

變量配置

  • user：user()
  • date： date(“yyyy/MM/dd”)
  • time：time(“HH:mm”)
  • param：groovyScript(“if(\”${_1}\”.length() == 2) {return ”;} else {def result=”; def params=\”${_1}\”.replaceAll(‘[\\\\[|\\\\]|\\\\s]’, ”).split(‘,’).toList();for(i = 0; i < params.size(); i++) {result+=’\\n’ + ‘ * @param ‘ + params[i] + ‘ ‘}; return result;}”, methodParameters());
  • return：methodReturnType()

方法註釋使用
在java方法上輸入/**後，按下tab鍵，即可在方法上方生成方法註釋，如下：

/**
 * （①方法描述）
 * @author keriezhang
 * @date 2016/05/07 10:07
 * @param message （②參數描述）
 * @param name （②參數描述）
 * @return java.lang.String （③返回值描述）
 */
public String myTest(String message,String name){
 return "";
}

到此這篇關於IDEA代碼規范插件P3C+代碼註釋模板配置方法的文章就介紹到這瞭,更多相關IDEA代碼規范插件P3C內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：