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

相关推荐
workflower3 小时前
单元测试-例子
java·开发语言·算法·django·个人开发·结对编程
YuanlongWang3 小时前
C# 基础——装箱和拆箱
java·开发语言·c#
b78gb3 小时前
电商秒杀系统设计 Java+MySQL实现高并发库存管理与订单处理
java·开发语言·mysql
wb043072014 小时前
性能优化实战:基于方法执行监控与AI调用链分析
java·人工智能·spring boot·语言模型·性能优化
天若有情6735 小时前
Java Swing 实战:从零打造经典黄金矿工游戏
java·后端·游戏·黄金矿工·swin
lichong9516 小时前
Android studio 修改包名
android·java·前端·ide·android studio·大前端·大前端++
lichong9516 小时前
Git 检出到HEAD 再修改提交commit 会消失解决方案
java·前端·git·python·github·大前端·大前端++
@yanyu6666 小时前
Tomcat安装与HTML响应实战
java·tomcat·html
Chen-Edward7 小时前
有了Spring为什么还有要Spring Boot?
java·spring boot·spring
陈小桔8 小时前
idea中重新加载所有maven项目失败,但maven compile成功
java·maven