idea里边创建类的时候和方法自动生成注释

idea里边创建类的时候和方法自动生成注释

我们经常写代码的时候需要在类上编写注释,标明这个类是谁写的有什么作用,其实每次写都会发现有很多相同的字段,比如作者,创建时间,类名等,有的时候方法上也要标明方法的返回值,参数等信息,在idea里边我们可以给设置自动加载注释。

1、创建类的时候自动加上注释

首先在idea里边选择file——setting根据如图所示进行操作
在这里插入图片描述
在includes里边的添加注释配置
在这里插入图片描述

/**
 * @Author liwenyan
 * @Date ${DATE} ${TIME}
 * @PackageName:${PACKAGE_NAME}
 * @ClassName: ${NAME}
 * @Description: TODO
 * @Version 1.0
 */

点击apply,这里就配置成功了,点击ok就退出配置页面了,所以我就先apply一下,配置完方法注解再去进行测试,如果你退出去了也没事,原路找回来就行

2、在方法上添加注解(File–>Settings–>Editor–>Live Templates)

点击右上角的加号新建Template Group
在这里插入图片描述
自己可以随意命名一个名字
在这里插入图片描述
然后选中新建的这个组,然后点击右上角+号,选择Live Template

IDEA还没有智能到自动为我们创建方法注释,这就是要我们手动为方法添加注释,使用Eclipse时我们生成注释的习惯是/**+Enter,这里我们也按照这种习惯来设置IDEA的方法注释

按照下图填入信息,我个人理解为*为一个触发器的存在,啊哈哈哈哈
在这里插入图片描述

/*
 * 
 * $VAR1$ 
 $params$* @return $returns$
 * @author lwy
 * @creed: Talk is cheap,show me the code
 * @date $date$ $time$
 */

当然这并不是所有人都是这样的,你可以选择你自己需要的参数留着

同样的方式再创建一个方法注解

在这里插入图片描述

/*
 * 
 * $VAR1$ 
 $params$* @return $returns$
 * @author lwy
 * @creed: Talk is cheap,show me the code
 * @date $date$ $time$
 */

其实这个还不是很智能的有些脚本还是需要自己去写的,可能你也看到有其他的博主写的很复杂,我之前看的时候也没怎么看明白,后来就找了简单的操作,可以供正常使用,选择如图所示的位置

在这里插入图片描述
配置一下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())

在这里插入图片描述
在这里插入图片描述
选择ok,这样我们配置就结束了,就可以去进行测试操作了。

首先我们先创建一个测试类,发现自动生成了

在这里插入图片描述
接下来写个方法,方法上/**回车

在这里插入图片描述
至此配置成功

  • 7
    点赞
  • 19
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
回答: 在IDEA中,可以通过设置自动加载注释来实现方法自动生成注释。具体操作步骤如下: 1. 打开IDEA,点击顶部菜单栏的"File"。 2. 在下拉菜单中选择"Settings"。 3. 在弹出的窗口中,选择"Editor",然后选择"File and Code Templates"。 4. 在右侧面板中找到"Includes"标签,并展开它。 5. 在"Includes"标签下,找到"File Header"并双击打开。 6. 在打开的编辑框中,可以看到默认的注释模板。将其中的作者、创建时间、描述等信息按照需要进行修改。 7. 修改完成后,点击"OK"保存设置。 通过以上步骤设置好自动加载注释后,每次在IDEA中编写方法时,可以在方法上方输入"/**"(或者快捷键Ctrl+Shift+Slash),按下回车键,系统就会自动根据设置生成注释模板,包括作者、创建时间、描述等信息。这样就可以快速生成方法注释,提高代码编写的效率。<span class="em">1</span><span class="em">2</span><span class="em">3</span> #### 引用[.reference_title] - *1* *3* [idea里边创建的时候和方法自动生成注释](https://blog.csdn.net/m0_50052896/article/details/122431890)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v92^chatsearchT0_1"}}] [.reference_item style="max-width: 50%"] - *2* [Idea中给方法自动添加注释](https://blog.csdn.net/hahaha_1112/article/details/122805567)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v92^chatsearchT0_1"}}] [.reference_item style="max-width: 50%"] [ .reference_list ]

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值