快捷導(dǎo)航

IDEA代碼規(guī)范插件P3C+代碼注釋模板配置方法

更新時(shí)間：2021年01月07日 11:01:49 作者：小鵬子的博客

這篇文章主要介紹了IDEA代碼規(guī)范插件P3C+代碼注釋模板配置方法,本文通過(guò)圖文并茂的形式給大家介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值，需要的朋友可以參考下

IDEA配置阿里規(guī)范插件P3C

進(jìn)入idea -》File -》 Settings -》Plugins

Plugins 搜索插件

到搜索框中搜索：Alibaba Java Coding Guidelines 下載安裝插件，安裝之后重啟IDEA ，進(jìn)入你的編輯器右擊會(huì)發(fā)現(xiàn)多

了，檢查規(guī)范和關(guān)閉檢查。

使用規(guī)范檢查

檢查會(huì)發(fā)現(xiàn)你這個(gè)java文件是否存在問(wèn)題并給出提示如：

規(guī)范提示

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

所有的類都必須添加創(chuàng)建者信息
所有的抽象方法（包括接口中的方法）必須要用javadoc注釋、除了返回值、參數(shù)、異常說(shuō)明外，還必須指出該方法做什么事情，實(shí)現(xiàn)什么功能。

通過(guò)添加java 類、方法注釋模板來(lái)滿足這些需求

開發(fā)工具 :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，用于填充自動(dòng)生成的注釋中的作者@author屬性。添加一行 -Duser.name=xxx （xxx為名稱）

全局中USER

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

添加class模板

增加注釋模板內(nèi)容：

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

新創(chuàng)建java文件時(shí)，會(huì)提示輸入類描述description，生成的文件格式如下：

package tuan.press.test;

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

配置方法注釋 Editor->Live Template->java 新建Live Template，進(jìn)行如下配置：

方法模板描述

第5步，適用場(chǎng)景配置如下：

添加java所以場(chǎng)景

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

在這里插入圖片描述

配置參數(shù)

縮寫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 （②參數(shù)描述）
 * @param name （②參數(shù)描述）
 * @return java.lang.String （③返回值描述）
 */
public String myTest(String message,String name){
 return "";
}

到此這篇關(guān)于IDEA代碼規(guī)范插件P3C+代碼注釋模板配置方法的文章就介紹到這了,更多相關(guān)IDEA代碼規(guī)范插件P3C內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: