IntelliJ IDEA自动生成自定义的类注释和方法注释

简介: IntelliJ IDEA自动生成自定义的类注释和方法注释

实现效果:不用手写即可自动生成如下图的类上注释和方法上的注释,我们只需要填写方法注释的参数和返回值文字描述即可,大大节省了代码开发的时间提高代码开发效率。

image.png

自定义的类注释

       File-->Settings-->Editor-->File and Code Templates


       注解内容可自定义,我给出的模板只是我自己的内容


/**
  @author : mereign
  @date : ${DATE} - ${TIME}   
  @desc : 
*/

image.png

自定义方法注释

       File-->Settings-->Editor-->LiveTemplates

第一步:新建一个分组,名称自定义

image.png



第二步:编辑模板

** 
 * 
 *$params$ 
 * @return 
 */

image.png

第三步:编辑变量


groovyScript("
  def result=''; 
  def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); 
  for(i = 0; i < params.size(); i++) {
  if(i == 0 && params[0] == '') result=' @Param void';
  else if(i == 0) result += ' @param ' + params[i] + ' ' + ((i < params.size() - 1) ? '\\n' : '');
  else result += '     * @param ' + params[i] + ' ' + ((i < params.size() - 1) ? '\\n' : '')
  }; 
  return result", methodParameters()
)

image.png


第四步:编辑快捷键最后一步

image.png

效果展示

image.png


相关文章
|
18天前
|
设计模式 数据可视化 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”中设置。批量生成时,可多选变量一次性生成。
|
25天前
|
Java
IDEA 利用groovy脚本生成注释
【10月更文挑战第29天】在 IntelliJ IDEA 中,可以通过创建和运行 Groovy 脚本来自动生成 Java 类方法的 Javadoc 注释。首先,创建一个 Groovy 文件并编写脚本,该脚本会检查每个方法是否已有注释,如果没有,则生成包含方法描述、参数列表和返回值的基本注释。接着,通过“Tools”菜单下的“Groovy Console”运行脚本,确保脚本中的包版本与当前使用的 IntelliJ IDEA 版本匹配。运行后,脚本将自动为选定类的方法添加注释。建议在执行前备份代码,以防意外。
|
1月前
|
SQL 存储 关系型数据库
MySQL 与 IntelliJ IDEA 同时兼容的注释
MySQL 与 IntelliJ IDEA 同时兼容的注释
29 2
|
1月前
|
人工智能 Java 数据库连接
IDEA开发 常用代码规范插件 常用辅助类插件
IDEA开发 常用代码规范插件 常用辅助类插件
47 0
|
2月前
|
Java 应用服务中间件 Spring
IDEA 工具 启动 spring boot 的 main 方法报错。已解决
IDEA 工具 启动 spring boot 的 main 方法报错。已解决
|
1月前
|
Java
IDEA自定义配置注释模板,让你看起来更加专业!!!
IDEA自定义配置注释模板,让你看起来更加专业!!!
|
3月前
|
Java
Java系列之 IDEA 为类 和 方法设置注解模板
这篇文章介绍了如何在IntelliJ IDEA中为类和方法设置注解模板,包括类模板的创建和应用,以及两种不同的方法注解模板的创建过程和实际效果展示,旨在提高代码的可读性和维护性。
|
Java Android开发
Idea使用系列之一:Idea设置类注释模板和方法注释模板
现在Idea越来越流行了,自己慢慢开始从Eclipse转向Idea开发。刚开始使用Idea,肯定会遇到各种各样的设置问题,所以在博客上专门有个文章系列进行记录,希望给转Idea开发的同学一点帮助。 设置类模板 设置方法模板
Idea使用系列之一:Idea设置类注释模板和方法注释模板
IntelliJ IDEA 设置类注释模板
IntelliJ IDEA 设置类注释模板
173 0
下一篇
无影云桌面