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

相关文章
|
19天前
|
设计模式 数据可视化 Java
如何在 IDEA 中设置类路径
在 IntelliJ IDEA 中设置类路径,可以通过项目结构配置或模块设置来添加所需的库和依赖。具体步骤包括打开项目结构对话框、选择模块、添加类路径等。
|
9天前
|
Java Windows
IDEA不使用lombok,如何快速生成get和set方法
【11月更文挑战第10天】在 IntelliJ IDEA 中生成 `get` 和 `set` 方法有多种方式:通过菜单操作、使用快捷键或自定义模板。菜单操作包括选择“Code”菜单中的“Generate...”,快捷键为“Alt + Insert”。自定义模板可在“File”-&gt;“Settings”-&gt;“Editor”-&gt;“Code Style”-&gt;“Java”中设置。批量生成时,可多选变量一次性生成。
|
27天前
|
搜索推荐 Java 数据库连接
Java|在 IDEA 里自动生成 MyBatis 模板代码
基于 MyBatis 开发的项目,新增数据库表以后,总是需要编写对应的 Entity、Mapper 和 Service 等等 Class 的代码,这些都是重复的工作,我们可以想一些办法来自动生成这些代码。
30 6
|
1月前
|
人工智能 Java 数据库连接
IDEA开发 常用代码规范插件 常用辅助类插件
IDEA开发 常用代码规范插件 常用辅助类插件
47 0
|
1月前
|
Java Maven
震惊!idea专业版如何配置maven国内源手把手教学
文章提供了如何在IDEA专业版中配置Maven使用国内源(如阿里云)的详细步骤,以加快依赖下载速度,并解释了配置国内源的原因。
496 0
震惊!idea专业版如何配置maven国内源手把手教学
|
2月前
|
Java 应用服务中间件 Spring
IDEA 工具 启动 spring boot 的 main 方法报错。已解决
IDEA 工具 启动 spring boot 的 main 方法报错。已解决
|
2月前
|
XML Java Maven
idea配置maven步骤及常见问题
本文介绍了在IDEA中配置Maven的详细步骤,包括Maven的下载、系统环境变量的配置、Maven本地仓库的设置、镜像加速的配置,以及在IDEA中指定Maven路径和配置文件。同时,还提供了解决每次新建项目需要重新手动配置Maven问题的方法。
idea配置maven步骤及常见问题
|
1月前
|
Java
IDEA自定义配置注释模板,让你看起来更加专业!!!
IDEA自定义配置注释模板,让你看起来更加专业!!!
|
1月前
|
数据可视化 关系型数据库 MySQL
【IDEA】配置mysql环境并创建mysql数据库
【IDEA】配置mysql环境并创建mysql数据库
100 0
|
1月前
|
Oracle IDE Java
IDEA安装教程配置java环境(超详细)
IDEA安装教程配置java环境(超详细)
下一篇
无影云桌面