IDEA：类注释和方法注释

yololee_

已于 2023-01-16 14:37:28 修改

阅读量994

点赞数 1

分类专栏： idea 文章标签： intellij-idea java ide

于 2022-09-05 15:10:52 首次发布

本文链接：https://blog.csdn.net/weixin_43296313/article/details/126705842

版权

idea 专栏收录该内容

14 篇文章 0 订阅

订阅专栏

IDEA：类注释和方法注释

一、类注释

1.File–>settings–>Editor–>File and Code Templates–>Files

在这里插入图片描述

2.选择includes在空白处进行粘贴修改

/**
   * @ClassName ${NAME} 
   * @Description TODO
   * @Author hl
   * @Date ${DATE} ${TIME}
   * @Version 1.0
   */

在这里插入图片描述

实际效果

在这里插入图片描述

二、方法注释

1.创建模板

File–>Settings–>Editor–>Live Templates

在这里插入图片描述

methodTemplates 是我们的组名，然后在这个组下添加

在这里插入图片描述

2.设置模板内容

**
   * @MethodName $title$
   * @Description $description$ $param$ $return$ $throws$
   * @Author hl
   * @Date $date$ $TIME$
   */

代码的第一行必须要以* *开头，而不能以 / * *开头，否则会出现参数和返回值为空的情况

在这里插入图片描述

3.设置模板应用场景

在这里插入图片描述

如果曾经修改过，则显示为change而不是define

4.设置参数

第3步和第4步顺序不可颠倒，否则第5步将获取不到方法

在这里插入图片描述

param

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

return

  groovyScript("def result=''; def data=\"${_1}\"; def stop=false; if(data==null || data=='null' || data=='' || data=='void' ) { stop=true; }; if(!stop) { result += '\\r\\n' + '   * @return: ' + data; }; return result;", methodReturnType())