idea2020.2版本设置类和方法的自定义注释模板(代码片段)

jack_孟 jack_孟     2022-12-01     277

关键词:

  IDEA是目前普遍使用的Java开发编辑器,添加自定义的注释模板,一方面便捷好用,另外一方面可以规范开发。IDEA中设置模板分两种:1、创建Java类的注释,2、方法的注释。

  一、Java类的注释模板

  1、打开File→Settings,选择Editor→File and Code Templates→Files→Class。可以看到创建类的时候引入了File Header.java。

 

   2、接下来我们可以看一下Files旁边的Includes标签,里面的File Header就是我们要创建的File Header.java,右侧的空白出添加我们需要的模板就可以了,下面的描述是模板引用的变量使用方法,比如时间、包名、项目名等。

 

 

   3、比如我们设置如下的内容,点击OK,再创建类的时候就会自动生成注释。

 

   效果如下:

 

   二、方法的注释模板

   1、打开File→Settings,选择Editor→Live Templates。

 

   2、点击右侧的“+”选择Template Group,创建分组,分组名自定义,例如:MyTemplates,点击OK即可。

 

 

 

   3、找到刚创建的MyTemplates分组并选中,点击右侧的“+”,选择Live Template,写入要配置的内容:

 

   配置的内容:

  1)Abbreviation:模板的缩写,可以是【/*】【/**】【*】等,看个人习惯了,后面会介绍用法。

  2)Description:模板的描述,方便自己以后查找。

  3)Template text:模板的内容,参数名用 $参数名$ 格式。

  4)Options→Expand with:模板的扩展快捷键,可以按照个人习惯选择,我用的是Enter键,后面会介绍用法。

  4、配置模板格式

复制代码
/**
 * 功能描述:
 * TODO
 *
$params$
 * @return $return$
 * @author JohanChan
 * @date $DATE$ $TIME$
 */
复制代码

  如上,配置自己想要的格式,需要注意的是参数要顶头写,直接用$params$,前面不要有空格和【*】。

  5、设置变量参数

  点击Edit variables,列表中显示的就是刚刚配置的模板的参数 $参数名$,在Expression中下拉选择方法为其赋值;对于 $params$ 参数需要注意,IDEA给我们默认的是methodParameters()方法,这个方法是把形参显示在一行,我们需要的是一行一个参数这样显示,可以通过自定义脚本实现,把下面的脚本复制到Default value中,即可。

groovyScript("def result=\'\'; def params=\\"$_1\\".replaceAll(\'[\\\\\\\\[|\\\\\\\\]|\\\\\\\\s]\', \'\').split(\',\').toList(); for(i = 0; i < params.size(); i++) result+=\' * @param \' + params[i] + ((i < params.size() - 1) ? \'\\\\n\' : \'\'); return result", methodParameters())

 

 

   6、测试效果

  点击OK就可以完成配置,以上就配置完成。使用的时候,先创建一个方法,然后在方法外上一行中输入 /* 点击Enter键,就自动生成了对应的注释,注意:在方法外使用注释模板生成的注释不能生成param和return,目前我不知道什么原因,有知道原因和解决办法的小伙伴欢迎留言指教。这个问题的临时解决办法是:在方法内输入 /* 点击Enter键,生成注释后copy到方法外面使用。最终效果如下:

 

 

 

出处:https://www.cnblogs.com/JohanChan/p/14920079.html

idea类和方法注释模板设置(代码片段)

...好用,所以整理一下适用于自己的模板;一、首先我们来设置IDEA中类的模板:(IDEA中在创建类时会自动给添加注释)1、File-->settings-->Editor-->FileandCodeTemplates-->Files我们选择Class文件(当然你要设置 查看详情

idea类和方法注释模板设置(非常详细)(代码片段)

类注释:/**@ClassName:$NAME*@Author:zhuting*@Date:$DATE$TIME**/方法上的注释/**@Description//TODO$end$*@param:$param$*@return:$return$*@auther:Recently祝祝*@date:$date$$time$ 查看详情

idea类和方法注释模板设置(非常详细)(代码片段)

类注释:/***@ClassName:$NAME*@Author:Recently祝祝*@Date:$DATE$TIME*/方法上的注释/***@Description//TODO$end$*@param:$param$*@return:$return$*@auther:Recently祝祝*@date:$date$$t 查看详情

开发工具:idea类和方法注释模板设置(非常详细)(代码片段)

一、首先我们来设置IDEA中类的模板:(IDEA中在创建类时会自动给添加注释)1、File-->settings-->Editor-->FileandCodeTemplates-->Files我们选择Class文件(当然你要设置接口的还也可以选择Interface文件)(1)$NAME:设置类名,与下面... 查看详情

idea类和方法注释模板设置(非常详细)

...是专业玩博客的,写这篇文章只是为了让大家省事。这里设置的注释模板采用Eclipse的格式,下面先贴出Eclipse的注释模板,我们就按照这种格式来设置:类注释模板:             &nbs... 查看详情

idea设置类注释和方法注释【自定义】

参考技术A一、类注解设置二、类注释新建MyGroup,再建*其中paramexpression的值:三、生成javaDoc文档效果图: 查看详情

idea类和方法模板设置(代码片段)

...故事我忘了¢个人微信公众号:程序猿的月光宝盒软件:idea版本:2019.3.11.在idea中设置类模板/***@ClassName:$NAME*@Description:TODO*@Date:$DATE$HOUR:$MINUTE*@Author:金聖聰*@Version:1.0*/2.设置方法注释模板**TODO*@Author:金聖聰*@Date:$date$$time$*$param$*$return$*... 查看详情

idea类和方法注释模板(代码片段)

先看效果类创建类的时候先描述这个类干啥用的方法先说创建类的注释模板选择class类注释模板/****@description$description*@date$DATE$TIME*@author魏一鹤**/点击applyok就行了再说方法的注释模板点击加号选择第一项,创建分组,先叫us... 查看详情

idea设置自定义注释

详细:idea如何设置类头注释和方法注释2016年10月13日15:09:11标签:idea/注释/97989编辑删除idea和eclipse的注释还是有一些差别的。idea:类头注释:打开file->setting->Editor->FilrandCodeTemplates->Includes->FileHeader直接在右边的文件框... 查看详情

mavenidea2020.2及以上版本maven项目自动导入依赖的解决办法

对于低版本的IDEA,可以通过这两种方法设置自动导入Maven依赖。对于2020.2以上高版本的Maven,如下图所示。右上角这个m的图标点击一下即可。 查看详情

idea自定义类注释和方法注释(自定义groovyscript方法实现多行参数注释)(代码片段)

一、类注释1、打开设置面板:file->setting->Editor->fileandcodeTemplates选择其中的inclues选项卡,并选择Fileheader,如图。不要选择Files选项卡再设置Class,这样比较麻烦,而且这样设置以后没新建一个类都要自己写一次Date。2、在... 查看详情

idea自定义设置类注释以及方法注释+为什么这样子设置(代码片段)

一、类注释打开IDEA的Settings,点击Editor-->FileandCodeTemplates,点击右边File选项卡下面的Class,在其中添加图中红框内的内容:/***@authorjitwxs*@date$YEAR年$MONTH月$DAY日$TIME*/在我提供的示例模板中,说明了作者... 查看详情

lombokmacbook下在idea2020.2版本中使用@data没反应&idea2020.2版本如何安装lombok(代码片段)

需要安装Lombok插件,Lombok插件在IDEA2020.2版本的插件商店中是没有的,需要自己从JetBrains官网下载,下载链接在这里。下载完成后,通过Preferences-Plugins-InstallPluginfromDisk导入。Apply-OK后,再到pom.xml文件中引入Lombo... 查看详情

[idea]idea设置注释模板(代码片段)

...->LiveTemplates方法注释模板有3个操作:1、新建模板组2、设置模板3、编辑变量下面我将按照这个顺序图文并茂进行展示1、新建模板组点击下图中的TemplateGroup来新建模板组,命名为MyTemplateGroup 2、设置模板在该模板组下新建... 查看详情

idea模板注释及相关快捷键设置(代码片段)

IDEA模板注释及相关快捷键设置最近使用IDEA时发现自带的模板注释不怎么好用,因此自己根据网上的教程总结了适合自己的模板设置,可以一键生成类和方法的注释,废话不多说一起看看吧:第9步的类模板注释代码:/***@AutherJame... 查看详情

idea自定义livetemplates(方法模板类模板)(代码片段)

...同学不爱写注释,而是没有合适的载体和空间。IDEA模板设置入口模板设置入口:Preferences|Editor|LiveTemplates一、方法注释快速生成设置第一步点击➕号,增加模板,并设置快捷键为\'ff\',作用域为Java文件模板内容/***$desc 查看详情

idea自定义设置类注释以及方法注释+为什么这样子设置(代码片段)

一、类注释打开IDEA的Settings,点击Editor-->FileandCodeTemplates,点击右边File选项卡下面的Class,在其中添加图中红框内的内容:/***@authorjitwxs*@date$YEAR年$MONTH月$DAY日$TIME*/在我提供的示例模板中,说明了作者... 查看详情

java示例代码_创建用于spring安全表达式语言注释的自定义方法

java示例代码_创建用于spring安全表达式语言注释的自定义方法 查看详情