IntelliJ IDEA自动添加类注释和方法注释

IDEA可以快速生成类注释、方法注释吗,还可以快捷键添加行注释Ctrl+/、块注释Ctrl+Shift+/,下面就介绍这几种快捷键的用法.

1 类注释

在IDEA中,按如下步骤。File→Settings→Editor→File and Code Templates中找到class,然后如下图设置

 

注释的代码如下:

/**    
 * @author: zhaox     
 * @date:  ${DATE} ${TIME}
 * @Description: TODO
 * @modifiedBy:
 * @version V1.0 
*/

2 方法注释

在IDEA中,按如下步骤。File→Settings→Editor→Live Templates,然后点击右上角的加号,添加Template Group,我这边命名为annotation

然后在这个Group下面继续点击右上角的加号,添加Live Template,具体设置如下图所示:

Abbreviation中输入:*,Description里面可以随意输入,Template text里面输入下面的文件:

*
 * @author: zhaox
 * @description: TODO
 * @date: $date$ $time$
 * $params$
 * @return $returns$
 */

在这里要严格按照所写的来做,不然后面自动生成的方法注释会获取不到参数和返回值的

然后编辑右方的Edit variables给自定义参数设值,如下图:

param里面的代码如下:

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

这个时候设置好了,在已有的方法名上面输入:/**+Tab就会自动生成方法注释,如下图所示

 

posted @ 2020-09-05 14:04  子非鱼220  阅读(524)  评论(0编辑  收藏  举报