IDEA注解模板

---

 

目录：

1.生成类注释模板

2.生成方法注释模板 

  　 3.鼠标移动到方法上显示注释

参照网址：

https://blog.csdn.net/qq_34581118/article/details/78409782

https://blog.csdn.net/guo_ridgepole/article/details/83176535

1.生成类注释

 1）打开Editor -> File and Code Templates -> Files -> Class 

 

2）然后在新建java类时，会提示输入description,效果如下：

/**
*@Description: ${description}
*@author: 作者
*@date: ${YEAR}.${MONTH}.${DAY}
*/

（1）${NAME}：设置类名，与下面的${NAME}一样才能获取到创建的类名

（2）TODO：代办事项的标记，一般生成类或方法都需要添加描述

（3）${USER}、${DATE}、${TIME} 、${HOUR}、${MINUTE}：设置创建类的用户、创建的日期和时间，比如你想添加项目名则可以使用${PROJECT_NAME}

（4）${PROJECT_NAME} 项目名称

（5）1.0：设置版本号，一般新创建的类都是1.0版本，可以写死就可以了

2.生成方法注释

1）打开Editor -> Live Templates -> 点击右边加号为自己添加一个Templates Group -> 然后选中自己的Group再次点击加号添加Live Templates 

 2）然后设置自己喜欢的快捷键 在Abbreviation里面 记得在Applicable in 里面勾选,起码也要勾选class （下图@deprecated为反对违反的意思，打错单词了，应该是@Description）

Template text的编辑如下：

**
 * @Description:  
 $params$
 * @return: $returns$
 * @exception/throws: 
 * @author: 我是作者
 * @date:   $date$
 */

（注意1：上面**前并不是少了/   最开始我写成/**时，生成的注释*@ param 后面无参数）

（注意2：上面$params$处，我最开始写成*@param:  $params$  然后下面 3）步骤 params选择如图，

                 这样结果效果图为, 参数param显示成一行了，这样没有每个参数一行这样美观）

3）点击上图的 Edit variables，编辑如下

params内输入：

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）效果

 在具体方法输入  /# 并按Tab键就会自动生成注释如下（下图@deprecated为反对\违反的意思，打错单词了，应该是@Description）

 4）改成默认的快捷键

    之前方法的默认注释为  /** 加上回车就好出注释模板，这里只有稍微改动下即可满足。后面方法上  输入 /** 加上回车键即得。

 

3.鼠标移动到方法上显示注释

 如要实现如下图，鼠标放到方法上，IDEA就会弹出该方法注释信息：

 

 操作方法：

 打开  File --> setting --> Editor-->General