IntelliJ IDEA如何配置类和方法的注释模板

新建类的模板显示

打开IDEA配置Settings

打开Idea，依次选择【File】–> 【Settings】

Settings配置项

【File】–>【settings】–>【Editor】–>【File and Code Templates】–>【Files】–>【Class】

类注释模板配置

这里柯柯我就提供两个模板给大家，我用的是模板2

模板1：

/**
* @Description:    Java类作用描述
* @Author:         MirKKK
* @CreateDate:     $DATE$ $TIME$
* @UpdateUser:     MirKKK
* @UpdateDate:     $DATE$ $TIME$
* @UpdateRemark:   修改内容
* @Version:        1.0
* 
*/

模板2：

/**
 * @author			By--MirKKK
 * @time			$DATE$ $TIME$
 * @Version:        1.0
 * @QQ				2641195399
 * @Description
 * 					Java类作用描述
 */

进行测试

新建类时候就有啦！！！如下：

类注释模板配置

注意：
IDEA没有为我们创建方法注释（和Eclipse不一样），要我们手动为方法添加注释

使用Eclipse时我们生成注释的习惯是：/**+Enter，这里我们也按照这种习惯来设置IDEA的方法注释。
也可以自己定义其他名称的注释，方法一样：

Settings配置项

【File】–>【settings】–>【Editor】 --> 【Live Templates】 --> 【点击绿色的“+”】 --> 【Template Group】

创建模板组

自定义一个名称，我这里是：MyGroup

创建自己的模板

3）创建模板
选中新建的模板组（My Group） --> 点击“+” --> 1.Live Template
注意：
这里和上面的不一样 点击的使第一个1.Live Template：

模板设置

1. 模板前缀，设置为/** （这里可以设置为其他的，我习惯/**）
2. 模板注释描述
3. 模板注释内容，请复制上面的 模板1或者2
4. 设置模板中变量的取值
5. 执行按键，默认是Tab，我一般习惯改为Enter键。
6. 模板应用范围，一般是点击第一个进行全选操作。
   
   模板内容：

模板1：

/**
 * @author			By--MirKKK
 * @time			$date$ $time$
 * @Version:        1.0
 * @QQ				2641195399
 * @Description
 * 					Java类作用描述
 *
**/

模板2：(方法模板)

/**
* @author			By--MirKKK
* @time			 	$date$ $time$
* @Version:       	1.0
* @QQ				2641195399
* $params$
* @Return $return$
* @Description
* 					Java方法作用描述
**/

模板变量的取值设置

在这里设置模板变量取值，用脚本或用IDEA的方法 ：

方法参数param取值的脚本如下所示：

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) ? '\\r\\n' : '')}; return result", methodParameters())

返回参数param取值的脚本如下所示：

  groovyScript("def returnType = \"${_1}\"; def result = '* @return: ' + returnType; return result;", methodReturnType()); 

参数如果不显示看下面这个文章哦~：param和return不显示的解决方案

效果

建议：
类模板设置为其他
方法模板设置为*
如：

最终效果：

---

完结！撒花！
感谢各位大佬支持↓↓↓↓↓↓↓↓↓↓↓

【微信】二维码：