侧边栏壁纸
博主头像
liveJQ博主等级

沒有乐趣,何来开始

  • 累计撰写 145 篇文章
  • 累计创建 60 个标签
  • 累计收到 2 条评论

Intellij idea设置类和方法注释

liveJQ
2020-04-11 / 0 评论 / 0 点赞 / 566 阅读 / 767 字 / 正在检测是否收录...
广告 广告

IDEA中的File and Code Templates或者是 Live Templates这里就不多说了,很实用,来这里的应该都知道。但是细节问题还是需要说说,这里先贴模板。

类注释

/**
 * ${description}
 *
 * @author ${USER}
 * @since ${DATE}
 */

方法注释

模板

20200411_model.png

 
 * $description$
 * $params$         
 * @return $returns$
 */

注意:这上面还有个空行

description变量脚本

groovyScript("def result='请在此处输入方法描述信息';return result")

params变量脚本

groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList();
for(i = 0; i < params.size(); i++) {
if(params[i] == '') return result;
if(i==0) result += '\\n'; result+=' * @param ' + params[i] + ((i < params.size() - 1) ? '\\n' : '')}; return result", methodParameters())

最后将这三个变量勾选上Skip if defined即可。

使用说明(重点

在方法体外使用快捷键时,params为null或者return 为空的?

直接打出设置的快捷键是无法在方法外获得params参数的,需要先在前面打出/**

20200411_result.png

方法注释模板中,第一行为空行,也是因为上面的特点而特地优化的。

相关资料

  1. Groovy脚本教程
  2. IDEA 配置方法注释@param时自动参数的问题
0

评论区