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

相关推荐
云絮.5 分钟前
mybatis(二)
java·数据库·mybatis
西凉的悲伤6 分钟前
Guava-Retrying 重试框架详解
java·guava·重试框架·guava-retrying
SunnyDays101110 分钟前
使用 Java 高效管理 Excel 批注:添加、读取、修改和删除
java·开发语言·excel
const_qiu35 分钟前
第 2.5 章 2.5.8:质量关 —— 安全审查、UI/UX 审查与踩坑复盘
java·人工智能·安全·ui·ux
chde2Wang40 分钟前
hadoop部署错误-namenode address dfs.namenode.servicerpc-address not configured
java·大数据·hadoop
牛战士coding1 小时前
Java 对象写入 Redis 后类型变了?Jackson 多态序列化问题复盘
java·开发语言·redis
小白的码BUG之路1 小时前
Jenkins -- 配置jdk和maven
java·jenkins·maven
xiaoqiMikko1 小时前
Redis 实战(基础篇):把一个老 RedisUtil 搬到 Spring Boot 4,一路踩出来的坑(真机实测)
java·spring boot·redis
yuniko-n1 小时前
【JUC】读写锁
java·开发语言
yuzhiboyouye1 小时前
后端怎么评估工作量
java