idea类、方法注释模板 [美观、规范]

在编写代码时,总会要求在方法或者类上添加注释,一是为了提高代码书写质量,便于清楚地认知该类或者该方法的作用什么,是干什么的;二是为了使代码看起来更加美观;所以要使用注释模板,更好的对方法进行描述。

类注释模板

修改位置:
在这里插入图片描述
模板:

	/**
	*
	* @author user
	* @date  ${DATE} ${TIME}
	**/

作者:user 可以改为你自己的名字

方法注释模板

修改位置:
在这里插入图片描述

在Java右侧的 + 可以创建一个新的模板,我这里为 * 描述为method

模板:

	*
	 * @author user $data$$param$ $return$
	 */

1、如果下方出现警示,点击,选择 EveryWhere
2、点击左边的 Edit variables,对变量进行编辑
在这里插入图片描述

date:time("yyyy-MM-dd")
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())
returngroovyScript("return \"${_1}\" == 'void' ? null : '\\r\\n * @return ' + \"${_1}\"", methodReturnType())

效果

类:

/**
 * 《描述》
 * @author user
 * @date 2021/11/17 10:50
 **/

方法:

    /**
     *《描述》
     *
     * @param  请求参数
     * @return 返回结果
     * @author user 2021-11-17
     */
  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值