[IDEA_01] IDEA注释模板配置

本文主要记录了在编程过程中注释的一些快捷键配置,为了以后便于配置,特此记录,仅供参考。

本文适用于想配置idea但是又不知道如何配置的新手小白。文章主要有以下内容:

  • idea方法模板注释
  • 属性注释
  • 文件头注释

方法注释

打开Idea,再打开设置面板的【setting】--->【Live Template】点击 + 新建一个Template Group,我这里取名是UserDefine

选中刚刚创建的Template Group,点击刚刚的+;

新建一个Live Template,依次在输入框输入如下信息。

  • Abbreviation输入**
  • Description中添加该操作的注释,我这里写的是方法注释
  • 在右下方的Options中将Expand with修改为Enter
  • 在模板内容框中输入如下内容:
java 复制代码
** 
 * 功能: 
 *
 * @author Java
 * @date $date$ $time$
 $param$$return$*/

如下图所示:

点击Edit Variables按钮,给我们的变量赋值:

  • param参数取值如下:
java 复制代码
groovyScript("def result = '';def params = "${_1}".replaceAll('[\\[|\\]|\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {if(params[i] != '')result+='* @param ' + params[i] + ' ' +((i < params.size() - 1) ? '\r\n ' : '\r\n ')}; return result == '' ? null : result", methodParameters())
  • return取值如下:
java 复制代码
groovyScript("def returnType = "${_1}"; def result ='';if(returnType=='null'||returnType=='void'){return;}else{result += '* @return ';cls = returnType.split('<');for(i = 0; i < cls.size(); i++){temp = cls[i].tokenize('.');result += temp[temp.size() - 1] + ((i < cls.size() - 1) ? '<' : '');};return result + ' \r\n ';}", methodReturnType());

点击change,选中Java,如下图所示:

设置完上述设置之后,点击Apply在点击ok就可以在idea中使用了只需要/**+Enter键即可。如下图所示

属性注释

属性注释的配置比方法配置更加简单只需要按照下图的配置即可:

按照相同的方式添加一个Live Template,依次输入各个模块的信息,最后点击change,选中Java即可。

此时通过f+Tab组合键就可以形成注释模板,在其中输入字段注释即可,如下图:

文件注释

注释模板如下所示

java 复制代码
/**
 * @author:  Java  
 * 创建时间:  ${YEAR}年${MONTH}月${DAY}日 ${HOUR}:${MINUTE}
 * 文件描述:  ${Description}
 */

Class、枚举、接口文件都可以使用上述模板,按照下图配置即可。

相关推荐
程序员黑豆3 小时前
Java包装类:基本类型与对象的桥梁
java·前端·ai编程
mldong6 小时前
"applicant" 契约:退回发起人的闭环设计
java·架构
月华路7 小时前
G1 垃圾回收:脏卡队列、记忆集与并发精化线程机制
java·开发语言
gugucoding7 小时前
47. 【Java】Java内存模型(JMM)与可见性
java·开发语言
zww89491118 小时前
校园跑腿系统开发实战指南:从需求分析到上线部署全流程解析
java
Fluxart.ai8 小时前
电商商品图审核怎么自动化?规则引擎、人工复核与发布门禁
java·前端·自动化
名字还没想好☜9 小时前
Java 线上内存泄漏排查实战:jmap 导堆、MAT 找 GC Roots 与四类常见泄漏
java·开发语言·jvm·内存泄漏
IT爱学堂10 小时前
尚硅谷 - 2025年3月Java+AI大模型应用开发
java·开发语言·人工智能
小贤plus11 小时前
SpringBoot 三大核心注解精讲:@ControllerAdvice、@RestControllerAdvice、@Validated 分组校验(实战)
java
吠品12 小时前
Java byte数组与String互转:编码细节与踩坑记录
java·linux·服务器