首页 > 其他分享 >IDEA自定义配置注释模板,让你看起来更加专业!!!

IDEA自定义配置注释模板,让你看起来更加专业!!!

时间:2024-06-02 23:30:22浏览次数:21  
标签:return 自定义 IDEA 点击 params Template 模板

一:类注释

我们先来康康成果:

在以上的代码中我们可以看到只要创建一个类,idea自动会给你补充注释消息,有作者信息和创建时间
关于模板参数代码我已经放到下面了:

/**
 *@author: dlwlrma
 *@data ${YEAR}年${MONTH}月${DAY}日 ${TIME}
 */

 使用方法:

打开IDEA的Settings,点击Editor-->File and Code Templates,点击右边File选项卡下面的Class,在其中添加上述代码注释就OK了

二:方法注释

先来康康成果

 在方法上面我们是可以根据参数的类型和有无返回值来定义注释的

具体过程如下:

首先点击Settings中点击Editor-->Live Templates 点击最右边的 +,

首先选择 2. Template Group... 来创建一个模板分组:

在弹出的对话框中填写分组名,我这里叫做 userDefine

然后选中刚刚创建的模板分组 userDefine,然后点击 +,选择 1. Live Template:

创建模板

此时就会创建了一个空的模板,我们修改该模板的 Abbreviation、Description 和 Template text。需要注意的是,Abbreviation 必须为 * ,最后检查下 Expand with 的值是否为 Enter 键。

点击 Define,在弹框中勾选Java,表示将该模板应用于所有的 Java 类型文件。

设置 applicable contexts

还记得我们配置 Template text 时里面包含了类似于 $date$ 这样的参数,此时 IDEA 还不认识这些参数是啥玩意,下面我们对这些参数进行方法映射,让 IDEA 能够明白这些参数的含义。点击 Edit variables 按钮。

需要注意的是,date 和 time 的 Expression 使用的是 IDEA 内置的函数,直接使用下拉框选择就可以了,而 param 和return 需要我们自己来实现。

Template text 内容如下:

*
 *
 * @author dlwlrma
 * @date $date$ $time$$param$ $return$
 */

 

param中的参数有:

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 ' : '')}; return result == '' ? null : '\\r\\n ' + result", methodParameters())

 return中的参数有:

groovyScript("return \"${_1}\" == 'void' ? null : '\\r\\n * @return ' + \"${_1}\"", methodReturnType()

之后点击OK,就大功告成了!!!

标签:return,自定义,IDEA,点击,params,Template,模板
From: https://blog.csdn.net/2301_76613040/article/details/139399061

相关文章

  • # window10 设置一个【自定义运行】命令行快捷方式
    window10设置一个【自定义运行】命令行快捷方式window10[运行】命令行打不开,可采用如下简单快捷方法:1、右键点击桌面空白处,然后点击【新建】,再点击【快捷方式】。2、在【请键入对象的位置】文本框输入:explorershell:::{2559a1f3-21d7-11d4-bdaf-00c04f60b9f0}3......
  • 自定义类型:结构体类型
    在学习完指针相关的知识后将进入到c语言中又一大重点——自定义类型,在之前学习操作符以及指针时我们对自定义类型中的结构体类型有了初步的了解,学习了结构体类型的创建以及如何创建结构体变量,还有结构体成员操作符的使用,现在我们将继续结构体相关知识的学习,希望在在看完本篇后......
  • c语言:自定义类型(结构体)
    前言:  我们在c语言中学过许多数据类型,有整型,浮点型,字符型,布尔型,甚至还有指针类型,那么自定义类型是什么呢?举个例子:如果我们要在c语言中表示一个整数,我们就会去使用整型去表示它,如果我们要表示一个字符,我们就会使用字符类型表示它们,这些都是c语言中自带的类型,我们只需要记......
  • 【模板】线段树
    #include<iostream>#defineintlonglongusingnamespacestd;constintMAXX=1e5+11;inta[MAXX];structnode{ intl,r,sum,add;//add为懒标记}tree[MAXX*4];voidpushup(intpos){ tree[pos].sum=tree[pos*2].sum+tree[pos*2+1].sum;}......
  • 『手撕Vue-CLI』下载指定模板
    开篇经上篇文章的介绍,实现了获取下载目录地址,接下来实现下载指定模板的功能。背景通过很多章节过后,已经可以拿到模板名称,模板版本号,下载目录地址,这些信息都是为了下载指定模板做准备的。实现如何从GitHub下载模板可以借助download-git-repo这个库来下载GitHub上的模......
  • 班级网页制作 HTML个人网页设计 我的班级网站设计与实现 大学生简单班级静态HTML网页
    ......
  • 个人介绍网页代码 html静态网页设计制作 dw静态网页成品模板素材网页 web前端网页设计
    ......
  • 网关(Gateway)- 自定义过滤器工厂
    自定义过滤工厂类DemoGatewayFilterFactorypackagecom.learning.springcloud.custom;importorg.apache.commons.lang.StringUtils;importorg.springframework.cloud.gateway.filter.GatewayFilter;importorg.springframework.cloud.gateway.filter.GatewayFilterChai......
  • C++实现自定义容器类型的范围循环
    先看一下类的设计与实现:classMyStack{public:MyStack()=default;MyStack(int*p,size_tlen):d(p),size(len){}int*begin(){returnd;}int*end(){return&d[size];}private:int*d=nullptr;size_tsize......
  • Idea中关于输出控制台中文乱码解决
    元注解@Target(value={ElementType.TYPE})@Retention(value=RetentionPolicy.RUNTIME)public@interfaceComponent{Stringvalue();}实体类@Component("userBean")publicclassUser{}*测试@TestpublicvoidComponentScan()throwsUnsupport......