IDEA中配置类与方法注释模板

简介: IDEA是当前使用最为广泛的集成开发工具之一,其功能的多样性与便捷性为开发者在开发过程提供了很多方便。我们在用IDEA创建java类和方法的时候,可以自动生成文档注释,便于代码的阅读与理解。

IDEA是当前使用最为广泛的集成开发工具之一,其功能的多样性与便捷性为开发者在开发过程提供了很多方便。

我们在用IDEA创建java类和方法的时候,可以自动生成文档注释,便于代码的阅读与理解。

一、IDEA配置类注释模板

①我们打开IDEA,选择[文件]-->[设置],打开设置页面

图片1.png

②从中选择[文件和代码模板],在打开的窗口中选择[Class]

图片2.png

③在右侧显示框中输入注释模板

/*** @description:TODO* @author     :xxx* @date       :${YEAR}/${MONTH}/${DAY} ${TIME}*/

其中${YEAR}/${MONTH}/${DAY} ${TIME}为获取当前时刻的年、月、日以及时间点

④点击“启用代码模板”,然后点击“应用”。

图片3.png

⑤这样,类注释就配置完毕了。在创建新文件时,会自动插入此文档注释模板。

图片4.png

二、IDEA配置方法注释模板

IDEA配置方法注释模板相对来说较为复杂。

①打开IDEA,选择[文件]-->[设置],打开设置页面

图片1.png

②从中选择[代码模板],在打开的窗口中点击右侧的“+”键,选择“2.Template Group...”创建代码模板分组

图片5.png

③给代码模板分组取名

图片6.png

④选中该分组,在窗口中点击右侧的“+”键,选择“1.Live Template”创建实时代码模板

图片7.png

⑤点击该模板,为其添加好缩写(快捷键)和代码描述

图片8.png

⑥在模板文本中输入代码模板,点击“编辑变量”,打开编辑变量页面

/*** create by: $author$* description: TODO* create time: $date$ $time$* $params$* @return $returns$*/

图片9.png

⑦在“编辑模板变量”中为代码模板中设置的变量设置表达式

其中“author”设置默认值“xxx(你想要的名字)”;“data”选择“data()”方法,“time”选择“time()”方法,“returns”选择“methodReturnType()”方法,“params”选择输入

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

自动获取当前日期、时刻、提交的参数值和返回的参数值。点击确定,回到编辑代码模板页面

图片10.png

⑧在下面点击“define”为模板设定语言

图片11.png

⑨在弹出的页面中勾选“java”

图片12.png

⑩在所有的操作都完成之后,点击“应用”,完成方法注释模板配置。

在某个方法内部,输入刚刚设置的注释模板缩写(快捷键),再点击“Tab”键(默认),即可生成该方法文档注释。

图片13.png

注:一定要在方法内部插入注释,然后将注释移到方法上方。如果在方法外可能会出现获取不到参数值和返回值的情况。

图片14.png

相关文章
|
10月前
|
Java 应用服务中间件 Maven
在IntelliJ IDEA中如何配置使用Maven以创建Tomcat环境
所以,别担心这些工具看起来有些吓人,实际上这些都是为了帮助你更好的完成工作的工具,就像超市里的各种烹饪工具一样,尽管它们看起来可能很复杂,但只要你学会用,它们会为你烹饪出一道道美妙的食物。这就是学习新技能的乐趣,让我们一起享受这个过程,攀登知识的高峰!
666 27
|
10月前
|
Java 应用服务中间件 Apache
在IntelliJ IDEA中使用Maven配置Tomcat环境
此配置方法具有较高的实用性,简单易懂。遵循以上步骤,您将能顺利在IntelliJ IDEA中使用Maven配置Tomcat环境,从而进行Web项目的开发和调试。
1252 18
|
11月前
|
缓存 Java Spring
IDEA中配置HTML和Thymeleaf热部署的步骤
以上就是在IntelliJ IDEA中配置HTML和Thymeleaf热部署的步骤。这样的配置可以大大提高你的开发效率,让你更专注于代码的编写,而不是等待应用的重启。希望这个指南对你有所帮助!
824 21
|
12月前
|
IDE 程序员 开发工具
只用正版!教你5个方法,白嫖JetBrains家族的所有产品,包含:IntelliJ IDEA、PyCharm、WebStorm、CLion、Rider
程序员晚枫分享了5种官方认证的免费使用JetBrains家族产品的方法,包括内容创作者计划、开源项目支持、教育许可证、用户组支持和开发者认可计划。这些方法帮助个人开发者与小型团队合法获取强大开发工具,如IntelliJ IDEA、PyCharm等,降低开发成本,提升效率。同时提醒大家遵守使用规范,尊重知识产权。
2197 13
|
Java Maven
Idea配置项目的热启动
Idea配置项目的热启动
2406 5
Idea配置项目的热启动
|
人工智能 自然语言处理 Java
IDEA + 通义灵码 AI 程序员:快速构建 DDD 后端工程模板
本文介绍了如何利用 IntelliJ IDEA 编辑器和阿里云的通义灵码 AI 程序员,快速搭建一个基于 DDD 领域驱动架构的后端工程模板。
|
Android开发
Idea_学习_07_Idea常用配置
      二、参考资料 1、Android Studio 入门级教程(一)
912 0
|
IDE Oracle Java
day4:JDK、IntelliJ IDEA的安装和环境变量配置
【7月更文挑战第4天】🏆本文收录于「滚雪球学Java」专栏,专业攻坚指数级提升,希望能够助你一臂之力,帮你早日登顶实现财富自由🚀;同时,欢迎大家关注&&收藏&&订阅!持续更新中,up!up!up!!
693 0
|
网络协议 安全 Linux
在IntelliJ IDEA中使用固定公网地址远程SSH连接服务器环境进行开发
在IntelliJ IDEA中使用固定公网地址远程SSH连接服务器环境进行开发
851 2