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

相关推荐
小酒窝.7 分钟前
【多线程】多线程打印1~100
java·多线程
君爱学习11 分钟前
基于SpringBoot的选课调查系统
java
APIshop22 分钟前
Java 实战:调用 item_search_tmall 按关键词搜索天猫商品
java·开发语言·数据库
血小板要健康33 分钟前
Java基础常见面试题复习合集1
java·开发语言·经验分享·笔记·面试·学习方法
淼淼7631 小时前
安装jdk1.8
java·开发语言
毕设源码-朱学姐1 小时前
【开题答辩全过程】以 高校食堂餐饮管理系统的设计与实现为例,包含答辩的问题和答案
java
过期动态1 小时前
Java开发中的@EnableWebMvc注解和WebMvcConfigurer接口
java·开发语言·spring boot·spring·tomcat·maven·idea
摇滚侠1 小时前
IDEA 定义返回值快捷键
java·ide·intellij-idea
毕设源码-郭学长1 小时前
【开题答辩全过程】以 高校考勤管理系统为例,包含答辩的问题和答案
java·eclipse
A懿轩A2 小时前
【Maven 构建工具】从零到上手 Maven:安装配置 + IDEA 集成 + 第一个项目(保姆级教程)
java·maven·intellij-idea