[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、枚举、接口文件都可以使用上述模板,按照下图配置即可。

相关推荐
一叶飘零_sweeeet10 分钟前
在分布式环境下正确使用MyBatis二级缓存
java·分布式·mybatis
肥仔哥哥193035 分钟前
基于OpenCv做照片分析(Java)
java·人工智能·opencv·图像原理
没有bug.的程序员38 分钟前
JVM 学习与提升路线总结:从入门到精通的系统化指南
java·jvm·学习·提升
用户307429716715841 分钟前
Spring AI实战:基于ElevenLabs 实现文本转语音的实时音频流
java·spring boot·ai编程
二闹1 小时前
从@Transactional失效场景到传播行为原理
java·后端
赵星星5201 小时前
synchronized锁的是谁,看完这篇就明白了
java·后端
小张学习之旅1 小时前
线程池简单讲解
java·后端
叫我阿柒啊1 小时前
Java全栈开发面试实战:从基础到微服务的深度解析
java·jvm·微服务·vue3·springboot·全栈开发·restfulapi
cxyxiaokui0011 小时前
检索增强生成(RAG):打破模型知识壁垒的革命性架构
java·aigc
Monly211 小时前
Docker:部署Java后端
java·docker·容器