IDEA自動生成注釋模板的配置教程

更新時間：2025年04月18日 10:38:40 作者：代碼怪獸大作戰(zhàn)

本文介紹了如何在IntelliJIDEA中配置類和方法的注釋模板,包括自動生成項目名稱、包名、日期和時間等內(nèi)容,以及如何定制參數(shù)和返回值的注釋格式,需要的朋友可以參考下

項目場景

IDEA自動生成注釋模板配置方法（包括類模板和方法模板）

配置方法

類注釋模板

根據(jù)圖片的步驟，進(jìn)入設(shè)置類注釋模板處進(jìn)行修改填入相應(yīng)內(nèi)容。
File ——> Settings ——> Editor ——> File and Code Templates ——>File Header

定義類開頭的注釋

/**
*@BelongsProject: ${PROJECT_NAME}
*@BelongsPackage: ${PACKAGE_NAME}
*@Author: xxxx
*@CreateTime: ${YEAR}/${MONTH}/${DAY}  ${HOUR}:${MINUTE}
*@Description: TODO
*@Version: 1.0
*/

在這個模板中，我們使用了
$ {PROJECT_NAME}、$ {PACKAGE_NAME}、$ {YEAR}、$ {MONTH}、$ {DAY}、$ {HOUR} 和
$ {MINUTE} 內(nèi)置的模板變量來自動生成當(dāng)前項目名稱、包名以及當(dāng)前日期和時間。您可以在模板中編輯其他信息，如作者名、描述等。

步驟

在這里插入圖片描述

類注釋效果

在這里插入圖片描述

方法注釋模板

根據(jù)圖片的步驟，進(jìn)入設(shè)置類注釋模板處進(jìn)行修改填入相應(yīng)內(nèi)容。
File ——> Settings ——> Editor ——> Live Templates

定義方法開頭的注釋

方法注釋模板

**
* @description: TODO $description$
* @author: LLong
* @date: $date$ $time$
$param$
* @return: $return$
**/

注意：修改Edit Varuavkes中需要定義的參數(shù)以及生成方式（如：Expand with 為 enter）

date 參數(shù)

date("yyyy/MM/dd")

time 參數(shù)

time("HH:mm:ss")

param 參數(shù)

groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+=' * @param ' + params[i] + ((i < params.size() - 1) ? '\\n' : '')}; return result", methodParameters())

return 參數(shù)

groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split('<').toList(); for(i = 0; i < params.size(); i++) {if(i!=0){result+='<';};  def p1=params[i].split(',').toList();  for(i2 = 0; i2 < p1.size(); i2++) { def p2=p1[i2].split('\\\\.').toList();  result+=p2[p2.size()-1]; if(i2!=p1.size()-1){result+=','}  } ;  };  return result", methodReturnType())