idea 中配置注释的自动生成问题

一、类文件注释
1)配置新生成文件的注释:
在file Header中复制如下内容:

/** @ClassName: ${NAME}
 * @Description: 
 * @Author ${USER}
 * @Date ${DATE} ${TIME}
 * @Version V1.0
 */

2)给已经存在的类文件添加注释。在live templates中配置 快捷键cmt,可自定义.$desc$变量不要设置skip,其他可以设置skip这样可以让光标默认停留在功能描述

/** @ClassName:  $name$
 * @Description:$desc$ 
 * @Author $USER$
 * @Date  $date$ $time$
 * @Version V1.0
 */

 二.方法注释(在live templates中配置)
1)不要用/**开头,应该用*开头,快捷键用*号(生成时输入/**)。否则methodName()无法取到值。如下内容放入模板框:

*
 * @method $methodName$
 * @description 功能描述:
 *  $desc$ $END$
 * @date: $date$ $time$
 * @author: zhangcs
$param$
 * @return $return$
 */


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


3)$desc$变量不要设置skip,其他可以设置skip这样可以让光标默认停留在功能描述

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

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值