首页 > 其他分享 >添加class和方法注释头部模版

添加class和方法注释头部模版

时间:2023-12-01 11:48:31浏览次数:35  
标签:return 模版 IDEA param 生成 注释 class 模板

一、类注释

打开 IDEA 的 Settings,点击 Editor-->File and Code Templates,点击右边 File 选项卡下面的 Class,在其中添加图中红框内的内容:

/**
 * @author dxy
 * @date ${YEAR}年${MONTH}月${DAY}日 ${TIME}
 * @description:TODO
 */

在我提供的示例模板中,说明了作者、时间和描述,IDEA 支持的所有的模板参数在下方的 Description 中被列出来。

保存后,当你创建一个新的类的时候就会自动添加类注释。如果你想对接口也生效,同时配置上图中的 Interface 项即可。

二、方法注释

不同于目前网络上互相复制粘贴的方法注释教程,本文将实现以下功能:

1、根据形参数目自动生成 @param 注解
2、根据方法是否有返回值智能生成 @Return 注解

相较于类模板,为方法添加注释模板就较为复杂,首先在 Settings 中点击 Editor-->Live Templates。

点击最右边的 +,首先选择 2. Template Group... 来创建一个模板分组:

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

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

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

如果右下角出现 No applicable contexts yet ,这说明此时这个模板还没有指定应用的语言:

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

为每一个参数设置相对应的 Expression:

需要注意的是,date 和 time 的 Expression 使用的是 IDEA 内置的函数,直接使用下拉框选择就可以了,而 param 这个参数 IDEA 默认的实现很差,因此我们需要手动实现,代码如下:

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())

注:你还注意到我并没有勾选了 Skip if defined 属性,它的意思是如果在生成注释时候如果这一项被定义了,那么鼠标光标就会直接跳过它。我并不需要这个功能,因此有被勾选该属性。

类注释只有在新建类时才会自动生成

点击 OK 保存设置,完成!

三、Q & A

(1)为什么模板的 Abbreviation 一定要叫 \* ?Expand with 要保证是 Enter 键?

答:因为 IDEA 模板的生成逻辑是 模板名 + 生成键,当生成键是 Enter 时,我们输入 * + Enter 就能够触发模板。

这也同时说明了为什么注释模板首行是一个 * 了,因为当我们先输入 /*,然后输入 * + Enter,触发模板,首行正好拼成了 /**,符合 Javadoc 的规范。

(2)注释模板中为什么有一行空的 \*?

答:因为我习惯在这一行写方法说明,所以就预留了一行空的写,你也可以把它删掉。

(3)注释模板中 $time$$param$ 这两个明明不相干的东西为什么紧贴在一起?

答:首先网上提供的大部分 param 生成函数在无参情况下仍然会生成一行空的 @param,因此我对param 函数的代码进行修改,使得在无参情况下不生成 @param,但是这就要求 $param$

要和别人处在同一行中,不然没法处理退格。

(4)为什么 return 参数不使用 methodReturnType(), 而要自己实现?

答:methodReturnType() 在无返回值的情况下会返回 void,这并没有什么意义,因此我对 methodReturnType() 返回值进行了处理,仅在有返回值时才生成。

(5)为什么 $return$ 不是单独一行?

答:因为当 methodReturnType() 返回 null 时,无法处理退格问题,原因同第三点。

标签:return,模版,IDEA,param,生成,注释,class,模板
From: https://www.cnblogs.com/henuyuxiang/p/17869352.html

相关文章

  • idea 查看 class文件 出现 /* compiled code */
    idea在初始化的时候会默认自带反编译插件,但是在有的同学初始化的时候没有勾选上插件,从而导致不能正常的反编译,class类提示 /*compiledcode*/。 解决方案:选择file->settings->plugins,在installed的插件中搜索JavaBytecodeDecompiler,勾选上后点击右下角的a......
  • 关于layui使用弹出层模版后对应上传组件不工作的问题记录
    这里页面的聊天室是使用的弹出层:util.on('lay-on',{'open-chat-room':function(){layer.open({title:'项目聊天室',type:1,offset:&#......
  • class lombok.javac.apt.LombokProcessor
    classlombok.javac.apt.LombokProcessor(inunnamedmodule@0x4587f0f9)cannotaccessclasscom.sun.tools.javac.processing.JavacProcessingEnvironment(inmodulejdk.compiler)becausemodulejdk.compilerdoesnotexportcom.sun.tools.javac.processingtounn......
  • java.lang.ClassNotFoundException: javax.servlet.jsp.jstl.core.LoopTag问题的解决
    问题描述问题解决将这个依赖:改成这个依赖:......
  • ts文件使用class类引入SDK连接
    要在TypeScript文件中使用类引入并使用给定的代码,你可以创建一个类,并在类的构造函数中执行该段代码。以下是一个示例:classCollectEventSDK{constructor(){(function(win,exportObj){win['LogAnalyticsObject']=exportObj;if(!win[exportObj]){......
  • idea设置注释折叠,默认不可修改
     设置之前效果 设置之后效果 ......
  • css同时满足多个class写法
    css同时满足多个class的写法(取交集).el-menu-item.is-active{border-left:5px;border-color:#039EFD;border-right-style:solid;background-color:#D8F4FE;}css满足其中一个class的写法(取并集).el-menu-item,.is-active{border-left:5px;border-co......
  • (二十六)C#编程基础复习——Class类
    在C#中,类是引用类型的,其中包括状态(成员属性)和操作(成员方法和其他函数成员),我们可以动态创建类的实例(instance),这个实例也称为对象(object),我们可以通过类和对象来设计程序。一、类的定义类的定义需要使用class关键字,语法说明:访问修饰符用来指定类或类中成员的访问规则,可以忽略不写......
  • 如何显示变量注释和地址 (仅LAD和FBD)
       ......
  • 初中英语优秀范文100篇-007 A Model Student in My Class
    记忆树1Mygoodfriend,Marry,isourmonitor.翻译我的好朋友玛丽是我们的班长。简化记忆我好朋友句子结构主语:MygoodfriendMarry(我的好朋友玛丽)。其中,主语是一个名词短语,由代词“my”(我的)和名词“goodfriendMarry”(好朋友玛丽)组成。谓语:is(是)。这是一......