IDEA配置Java類方法注釋模板實踐

更新時間：2026年03月22日 11:25:10 作者：菜鳥中的拖拉機(jī)

這篇文章主要介紹了IDEA配置Java類方法注釋模板實踐,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教

一、類注釋模板

File -> Settings -> Editor -> File and Code Templates -> Files

選擇Class , Interface ，Enum 等等，我們都可以看到，在右側(cè)區(qū)域中，在public class 上面，都有一行 #parse(“File Header.java”)

這句代碼是引入了File Header.java文件，作為我們創(chuàng)建的Class Interface ,Enum 等文件的注釋，那么這個類在哪呢，我們可以看到，在 Files 右側(cè)，有一個 Includes 選項，

在這里，我們可以定義各種的模板，在需要的地方去引入這個模板，這里已經(jīng)在類文件中引入了File Header.java 模板，那我們就更改這個模板成為我們想設(shè)置成的樣子

自定義注釋模板

/**
 * @className: ${NAME}
 * @author: Kevin
 * @date:  ${DATE}
 **/

新建接口文件自動生成注釋，效果如下

/**
 * @className: CrowdService
 * @author: Kvein
 * @date: 2022年05月12日 15:33:00
 **/
public interface CrowdService {
}

注釋模板不完全變量參考表

預(yù)定義變量	描述信息
${NAME}	the name of the current file
${PACKAGE_NAME}	name of the package in which the new file is created
${USER}	current user system login name
${DATE}	current system date
${TIME}	current system time
${YEAR}	current year
${MONTH}	current month
${MONTH_NAME_SHORT}	first 3 letters of the current month name. Example: Jan, Feb, etc.
${MONTH_NAME_FULL}	full name of the current month. Example: January, February, etc.
${DAY}	current day of the month
${DAY_NAME_SHORT}	first 3 letters of the current day name. Example: Mon, Tue, etc.
${DAY_NAME_FULL}	full name of the current day. Example: Monday, Tuesday, etc.
${HOUR}	current hour
${MINUTE}	current minute
${PROJECT_NAME}	the name of the current project

二、方法注釋模板

File -> Settings -> Editor -> Live Templates

1.在Live Templates 右側(cè)點擊+號

添加一個Templates Group，命名為 methodTemplates

2.在剛剛創(chuàng)建的 methodTemplates 下

創(chuàng)建一個 Live Templates ，如下：

1）、在位置1處：輸入模板的簡寫碼

在位置2處：輸入模板的描述
在位置3處：輸入方法注釋模板樣式，可變變量要用 變量名變量名變量名 來表示，如：paramparamparam；
若不設(shè)置成如此的變量名，位置4不可點擊，模板如下：

/**
 * @title $title$
 * @author Kevin $param$
 * @updateTime $date$ $TIME$ $return$
 * @throws $throws$
 */

點擊位置4處：可編輯定義的變量的值，如下：

變量param 為方法的參數(shù)變量，需要根據(jù)方法的參數(shù)多少進(jìn)行變化；變量 return 為返回值類型，也要根據(jù)方法的返回值進(jìn)行變化，所一要自行設(shè)置該方法，設(shè)置的代碼如下，復(fù)制粘貼即可：

param :

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

return :

groovyScript("def result=''; def data=\"${_1}\"; def stop=false; if(data==null || data=='null' || data=='' || data=='void' ) { stop=true; }; if(!stop) { result += '\\r\\n' + ' * @return: ' + data; }; return result;", methodReturnType())

在位置3下方，點擊選擇該模板應(yīng)用的范圍，可選Everywhere 表示任何位置都可添加該注釋