idea 自動生成注釋

1 創建類時，自動生成注釋

模板代碼如下

/**
* @program: ${PROJECT_NAME}   
*
* @description: ${description}   
*
* @author: yun
*
* @create: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}     
**/

2 在方法上使用快捷鍵生成注釋

先新建一個template group,我命名為mygroup,再在group新建live template

實現參數類似eclipse的效果，多個參數自動換行

     /*** @Description: TODO 描述方法主要功能** @Param: pageNo* @Param: pageSize* @Param: filterTimestamp* @Return: java.util.List* @Author: yun* @Date: 2025/2/17 18:13*/List listV2(Integer pageNo, Long filterTimestamp);

template text模板如下

 ** @Description: TODO 描述方法主要功能* $param$* @Return: $return$* @Author: yun* @Date: $date$ $time$*/

注意這里需要左縮減一個空格

選擇模板應用到java代碼

edit variables進行模板參數編輯

如果param參數使用默認的methodParameters()來獲取方法參數值，其注釋參數是在一行展示的，如下圖。這里我們希望像MyEclipse中一樣，一行一個參數的樣式，可以通過腳本來實現。將以下腳本復制進Expression，可以得到文章開頭效果圖的樣式

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

3 效果

使用默認的拓展快捷鍵tab, /** + tab進行自動顯示方法注釋

如果

4 導入導出配置

5 參考鏈接

IDEA中設置注釋模板_idea配置注釋模板-CSDN博客