idea 自动添加注释 (方法+类 带参数/返回值)

news/2024/10/14 11:02:45

1.类自动注释

 左上角选择 File -> Settings -> Editor -> File and Code Templates,

 选择Files -> Class,在类声明上填入以下内容,并勾选Enable Live Templates 开启此模板

 其中${}为变量,可以使用默认自带的变量,在Description中有详细的列举,如果是自定义的变量,创建Class的时候会要求输入

/*** @description:TODO* @author     :xxx* @date       :${DATE} ${TIME}*/

 检验自动生成:

 

2.方法自动注释

 左上角选择 File -> Settings -> Editor -> Live Templates,

 点击加号,选择Template Group

输入任意名称

创建完成后,自动定位到刚创建的组,点击右上角,选择Live Template

自定义任意的Abbreviation,这里为了以后操作快捷,直接填写a

Template Text 内填入以下内容 (可根据个人需求自行修改),$xx$为自定义变量,可以手动输入,也可以选择自带的函数

复制代码
/*** @author: $author$* @description: TODO* @date: $date$ $time$
$params$* @return $returns$*/
复制代码

然后点击Edit variables ,配置变量

author为作者,可自定义内容;

date、time为时间,这里使用自带的函数;

returns为返回值,这里也使用自带的函数;

params为方法入参数,这里需要配置groovyScript函数,将下面的内容拷贝到Expression

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

填写后点击OK,最后选择适用范围,选择java,点击打勾

到这里配置就完成了,随便找一个方法,在方法上部输入刚刚设置的Abbreviation,这里是a,所以输入a,然后按Tab键就可以自动生成

这里有个小问题,生成的时候如果不在方法体内,入参如果不是vo等java类,就获取不到,所以建议在方法体内生成,然后移到方法上面

另:方法体外生成的位置必须是方法上部一行,如果在@Override上面使用就获取不到入参和返回值了,所以这里只能先生成注释,然后再把@Override等方法注解移到下面(不移也没关系,但不美观)

 

<a href="https://www.cnblogs.com/nvsky/p/11157485.html" class="p_n_p_prefix">« </a> 上一篇:    <a href="https://www.cnblogs.com/nvsky/p/11157485.html" data-featured-image="" title="发布于 2019-07-09 15:09">maven打包到本地仓库</a>
<br>
<a href="https://www.cnblogs.com/nvsky/p/11289174.html" class="p_n_p_prefix">» </a> 下一篇:    <a href="https://www.cnblogs.com/nvsky/p/11289174.html" data-featured-image="" title="发布于 2019-08-02 16:10">关于担心java import xxx.*对资源占用的一次小实践</a>

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.ryyt.cn/news/71374.html

如若内容造成侵权/违法违规/事实不符,请联系我们进行投诉反馈,一经查实,立即删除!

相关文章

前端未解决的问题记录

苹果手机中文符号旋转问题 <view class="right-area"><view style="--i:0"><text class="fix-label">功德主</text><text><text class="rotate-90">【</text>{{ order.initiator }}<tex…

突发:宕机崩溃OOM

突发:宕机崩溃OOM事故背景:我们的项目每年都进行一次三级等保认证,2024年*月*日认证公司对我们的项目进行渗透测试时,我们系统出现无法访问和使用的情况。出现问题后我们联系认证公司停止测试,系统依然没有恢复。 事故分析: 1. 出现问题后我第一时间检查了日志,发现了OO…

java报“非法字符:\65279”

1.今天跑老的项目代码时,某个class文件报错非法字符:\65279”,再此记录下解决方式!错误原因:原因就在于某些编辑器会往utf8文件中添加utf8标记(editplus称其为签名),它会在文件开始的地方插入三个不可见的字符(0xEF 0xBB 0xBF,即BOM),它的表示的是 Unicode 标记(BOM)…

AOT漫谈专题(第三篇): 如何获取C#程序的CPU利用率

一:背景 1. 讲故事 上篇聊到了如何对AOT程序进行轻量级的APM监控,有朋友问我如何获取AOT程序的CPU利用率,本来我觉得这是一个挺简单的问题,但一研究不是这么一回事,这篇我们简单的聊一聊。 二:如何获取CPU利用率 1. 认识cpuUtilization字段 熟悉.NET底层的朋友应该知道,…

【GIS前沿技术】什么是网格化(Gird)GIS?

文章目录 网格GIS的主要特点 网格GIS的优势 网格GIS工作原理 网格GIS实现技术 网格GIS是一种将地理空间数据组织成网格(格网)形式的地理信息系统。每个网格单元(通常称为“像元”或“格网单元”)代表特定的空间范围,具有固定的大小和形状。这种结构使得数据的存储、处理和…

请问公司网站如何修改电话

要修改公司网站上的联系电话,你可以按照以下步骤操作:登录网站后台:如果你的公司网站有CMS(内容管理系统)如WordPress或Drupal,你需要登录到该系统的管理后台。找到页面编辑器:在后台管理界面中,找到包含联系电话信息的页面,通常是“关于我们”、“联系我们”或者页脚…

公司网站修改_单位网站修改

为了帮助您更好地理解和执行公司或单位网站的修改工作,我将分步骤介绍一般性的网站修改流程和注意事项: 1. 确定修改目标明确网站需要改进的具体方面,如设计更新、功能增强、内容调整等。 收集用户反馈或分析现有数据来确定优先级。2. 规划与设计制定详细的修改计划,包括时…

怎么修改一个公司网站的网页?

要修改一个公司网站的网页,你可以按照以下步骤进行:获取权限:确保你有权限访问和修改网站的内容管理系统(CMS)或源代码。备份现有内容:在进行任何更改之前,先备份当前的网页文件或数据库内容,以防修改过程中出现问题。确定修改需求:明确你需要修改的具体内容,例如文本…