IDEA使用IDEA配置类注释模板和方法注释模板

Posted 2023-02-23 Yolanda94

【背景】

   最近小编在工作中正好接收了新项目，需要给原来的代码补注释，为了能够更加高效的写注释，所以在IDEA里配置了模板。个人感觉这个模板用着不错，所以将过程记录下来分享给大家。（并非权威，如有错漏，欢迎指正！不胜感激！）

【内容】

1、配置类注释模板

（1）选择Setting打开IDEA的设置面板，选择File and Code Templates-Files-Class进行配置。

（2）将规定的类注释模板覆盖原有的类注释模板

#if ($PACKAGE_NAME && $PACKAGE_NAME != "")package $PACKAGE_NAME;#end
#parse("File Header.java")

/**
 * @description $description
 * @author 自己的名字
 * @since $DATE $TIME
 */
public class $NAME 

2、配置方法注释模板

（1）选择Setting打开IDEA的设置面板，选择Live Templates，点击右上角的“+”添加Template Group并命名为myTemplates。

（2）选中myTemplates后点击右上角“+”为myTemplates添加Live Template。

（3）为该方法注释模板设置快捷键“+Enter”，设置完成后方法前输入回车后自动添加方法注释。

（4）将方法注释模板粘贴至Template text输入框里。

**
 * 功能描述
 *
$param$
 * @return $return$
 * @author 自己的名字
 * @since $date$ $time$
 */

（5）点击Edit variable，在弹出框中为注释模板的几个参数配置相应的表达式

Param的Default value：

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())
1

Return的Default value：

methodReturnType()

Date的Default value：

date()

Time的Default value：

time()

（6）将该方法注释模板配置为Java代码环境中使用。

附录：

参考博客：https://blog.csdn.net/sikefeng/article/details/80557265