類和方法注釋模闆
1.修改類注釋模闆
在File->Settings->Editor->File and Code Templates下分别修改Class,Interface,Enum等注釋模闆,Class模闆部分修改如下,其餘的舉一反三進行修改。
圖1:
![](https://img.laitimes.com/img/9ZDMuAjOiMmIsIjOiQnIsICM38FdsYkRGZkRG9lcvx2bjxiNx8VZ6l2cs0TPB5keJp3YrZ1MiNnTywEMW1mY1RzRapnTtxkb5ckYplTeMZTTINGMShUYfRHelRHLwEzX39GZhh2css2RkBnVHFmb1clWvB3MaVnRtp1XlBXe0xyayFWbyVGdhd3LcV2Zh1Wa9M3clN2byBXLzN3btg3Pn5GcugDO1QTMzUTM4IjMwkTMwIzLc52YucWbp5GZzNmLn9Gbi1yZtl2Lc9CX6MHc0RHaiojIsJye.png)
以下所示的${DESCRIPTION}是自定義變量,會在建立類時請求輸入。圖中圈住的裡面可以找到可以使用的變量。
#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")
package ${PACKAGE_NAME};
#end
public class ${NAME} {
}
類注釋模闆修改配置圖
圖2:
類注釋模闆修改效果圖
圖3:
2.方法注釋模闆修改
在File->Settings->Editor->Live Templates下添加自定義Template Group,并在自定義Template Group下添加自定義Template,具體配置如下圖所示
圖4:此圖中的所有設定資訊都是可直接用的,可以完全按照圖中填寫。
詳細配置參數
3處Template text内容如下:
*
*
$params$
* @return $returns$
* @author [email protected]
* @date $date$
*/
4處的名稱填寫*
然後點選上圖中紅色手寫7的按鈕彈出下面圖;
圖5:
Edit Template Variables請求參數部分内容如下:
params:後面的Expression中填寫下面這段代碼:
groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+=' * @param ' + params[i] + '\\t' + ((i < params.size() - 1) ? '\\n' : '')}; return result", methodParameters())
returns:後面填寫如圖中的方法;
date:填寫如圖;
在完成如上配置後,點選圖4中5所在的位置的藍色change(如果未定義過會是define)。然後勾選所有檔案。
再講圖4中6所示位置改為如圖的enter。
圖4中的資訊都是可用的,可完全按照圖中填寫。儲存即可。
隻需在方法上面一行執行/**+Enter鍵即可生成注釋
方法注釋模闆修改效果圖
圖6:
參考文章:
https://blog.csdn.net/yuruixin_china/article/details/80933835
https://zhuanlan.zhihu.com/p/32891910