IDEA设置类和方法注释模板

通过File and Code Templates设置模板

此方法适用于文件创建时自动生成,不支持快捷键生成。此处以生成java类模板举例说明。

路径: File–>settings–>Editor–>File and Code Templates–>Files
选择class添加模板:

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")
/**
* @ClassName: ${NAME}
* @Author: ${USER}
* @Date: ${DATE} ${TIME}
* @Description: TODO
*/
public class ${NAME} {
}

选择interface添加模板:

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")
/**
* @ClassName: ${NAME}
* @Author: ${USER}
* @Date: ${DATE} ${TIME}
* @Description: TODO
*/
public interface ${NAME} {
}

通过Live Templates设置模板

此方法适用于文件快捷键生成,不支持创建时自动生成。此处以生成java方法模板举例说明。

路径: File–>Settings–>Editor–>Live Templates
在这里插入图片描述
1. 新建自定义组(Template Group)
新建组,命名为userDefined

2. 在刚建的自定义组下新建模板(Live Template)
1)新建模板Method Comment,命名为mc

2)模板内容:**(注意:第一行,只有一个*而不是/*)

*
 * @Author: $user$
 * @Date: $date$ $time$
 * @Param: $param$
 * @Return: $return$
 * @Description: TODO
 */

在这里插入图片描述
3)上图中No applicable contexts yet警告,是因为没有设置模板的应用场景导致,点击Define设置为Java即可:
在这里插入图片描述
4)设置参数获取方式:
在这里插入图片描述

说明: 上图中红框标记的“Expand with”参数是用来设置生成快捷键的,可以根据自己的习惯自行设置,默认Tab键

重点说明

正确演示:

正确的生成方式为:/* + 自定义的Live Template模板名称 + 快捷键(默认Tab键)
以我上面设置的为例:/*mc + tab键
在这里插入图片描述
实际正确效果:
在这里插入图片描述

错误演示:

错误的生成方式为:自定义的Live Template模板名称 + 快捷键(默认Tab键)
以我上面设置的为例:mc + tab键
实际错误效果:
在这里插入图片描述

说明:
这样操作不仅注释格式错误,而且@Param和@Return参数并没有获取到值,最开始网上找了很多添加groovyScript脚本的方式,然并卵,在此踩过坑了,希望大家别再这种问题上浪费时间,特此奉上!!!

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值