IDEA自动生成类和方法注释

本文介绍了如何在IDEA中设置和使用注释模板,包括类注释和方法注释。类注释涉及作者、创建日期和描述,方法注释提供参数、返回值信息。用户可以通过预设的模板,在创建新类或方法时自动生成规范的注释,提高编码效率。
摘要由CSDN通过智能技术生成

效果图

 一、类注释

1. 创建

 

2. 向header文件中添加内容

/**
 * @author: 作者
 * @create: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
 * @Description: 
 */

3. class文件关联header配置

4. 使用方法

创建类时候自动生成。

二、方法注释

1. 

 

 输入模板内容:

注意格式不要修改了,否则会乱。

*
    * @Description:
    * $VAR1$
$params$ * @return $returns$
        */

 

VAR1参数内容:

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())

returns参数内容:

methodReturnType()

 修改关联文件类型和内容:

三、使用方法

方法注释前先按Tab,再键入 /** ,最后按回车。

    /**

 四、参考文章

idea自动生成方法注释(含参数、返回值、日期、作者)

IDEA设置自动生成类和方法注释

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值