IntelliJ Idea注释模板--类注释、方法注释

IntelliJ Idea注释模板--类注释、方法注释

一. 类注释模板配置

  1. 配置效果
    在这里插入图片描述
    在这里插入图片描述

  2. 配置方法

    在这里插入图片描述
    在这里插入图片描述

    /**
    * Created with IntelliJ IDEA.
    *
    * @Date: 2019/9/18
    * @Time: 17:25
    * @email: 
    * Description:
    */
    
    /**
     * Created by Zhangyh on ${YEAR}/${MONTH}/${DAY}.
     */
    

二. 方法注释模板配置

  1. 配置效果

    在这里插入图片描述
    注意:关于参数的注释,网上有一些配置是将多个参数列在一行,形如:@param [a, b],当然网上也提供了将多个参数列成多行的形式,即上图所示效果,这是用脚本实现的,但是网上的脚本因空格问题,老是对不齐,本人有强迫症,修改了一下(起始就是去了个空格),使之对的比较整齐,如上图所示效果。

  2. 配置方法

    (1) 打开页面配置
    在这里插入图片描述

(2)创建模板组

	【Editor】 --> 【Live Templates】 --> 【点击“+”】 --> 【Template Group】 --> 【输入名称,点击OK(我输入的是My Group)】,如下图中步骤1~4

在这里插入图片描述
(3)创建模板

    选中新建的模板组(My Group) --> 点击“+” --> 1.Live Template,如上图中步骤5~6

(4)模板设置:

1.设置模板前缀,如果设置为,使用时 /* + Enter键(第5步设置该按键),如果设置为a,使用时 /*a + Enter键,其他类推
 2.设置该模板应用范围,mothed表示方法,file表示类上面
 3.填写模板内容,具体内容会在后面补充,可以参考
 4.设置模板中变量的取值
 5.设置执行按键,默认是Tab,我一般习惯改为Enter键。该功能主要配合步骤1中的模板前缀使用
 6.设置模板应用范围,一般是点击第一个进行全选操作。
在这里插入图片描述
(5)模板内容

	/*
	* @Description TODO
	$params$
	* @Return $return$
	* @Author duzhijie
	* @Date $date$ $time$
	**/

(6)设置模板变量的取值,对应上图步骤4操作,如下
在这里设置模板变量取值,或者用脚本,或者用idea自带的方法,如

在这里插入图片描述

方法参数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) ? '\\r\\n' : '')}; return result", methodParameters())

注意:只有用这个脚本,多个参数才是才是各占一行,如果用 methidParameters(),则多个参数会只占一行,形如:@param [a, b]

该博客不经博主同意不可私自转载! ! !

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值