IDEA中设置注释模板的方法

摘要:
它们是创建java文件时类和方法的注释。用于在MyEclipse中设置注释模板的方法)。2.为方法设置注释模板。1.选择文件→ 设置→ 编辑→ LiveTemplates。原因可以从文章末尾的解释中看出。单击模板页面底部的警告定义以读取刚才在注释模板中配置的参数${parametername}$。在“表达式”的下拉框中,选择一种方法为其赋值。

  IDEA中设置注释模板主要分为两个部分,分别是创建java文件时类的注释和方法的注释。

  这里为大家详细介绍一下方法,按MyEclipse的风格设置(MyEclipse的请看:MyEclipse中设置注释模板的方法),大家可以根据自己的习惯生成自己喜欢的注释模板。效果如下:

 IDEA中设置注释模板的方法第1张

一、设置类的注释模板

1、选择File→Settings→Editor→File and Code Templates→Files→Class。可以看到创建Class时引入了一个参数"File Header.java"。对应的是Files旁边的Includes→File Header文件。

IDEA中设置注释模板的方法第2张

2、File Header里就是创建类时的注释模板,下面Description中有描述一些可以配置的参数,可以根据自己需要选用。

IDEA中设置注释模板的方法第3张

二、设置方法的注释模板

1、选择File→Settings→Editor→Live Templates。点击右边的加号,选择Template Group,创建一个分组。

IDEA中设置注释模板的方法第4张

2、再点击加号,选择Live Template,创建一个模板。其中:

Abbreviation:填模板的缩写,可以使用*号作为代号,方便后面调用模板。

Options→Expand with:填注释模板的扩展快捷键,根据使用习惯,这里使用默认的Tab。

Template text:填写注释模板的内容。参数名使用${参数名}$的格式。(注意:注释模板开头的/不要填写,原因可以看文章末尾的解释)

IDEA中设置注释模板的方法第5张

3、点击模板页面最下方的警告define,来设置将模板应用于哪些场景,选择Everywhere-->Java即可。(如果曾经修改过,则显示为change而不是define,如上图)

IDEA中设置注释模板的方法第6张

4、然后点击Edit variables,会读取刚刚在注释模板中的配置的参数${参数名}$。在Expression的下拉框中选择方法为其赋值。

IDEA中设置注释模板的方法第7张

5、参数赋值优化

(1)如果param参数使用默认的methodParameters()来获取方法参数值,其注释参数是在一行展示的,如下图。这里我们希望像MyEclipse中一样,一行一个参数的样式,可以通过脚本来实现。将以下脚本复制进Expression,可以得到文章开头效果图的样式:

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

IDEA中设置注释模板的方法第8张

(2)如果return参数使用默认的methodReturnType()来获取参数值,模板里使用了@link来跳转结果类型,那么当方法返回值为void时,注释会报错,如下图。可以通过脚本来避免,将上面模板中的@link参数去掉,将以下脚本复制进Expression:

groovyScript("def result="${_1}"; if(result == "void"){return "";}else{return "{@link "+result+"}";}", methodReturnType())

IDEA中设置注释模板的方法第9张

6、注释模板的调用。通过输入 / + * + Tab键,即先输 /* 再按Tab键,就可以调用模板。因为刚刚我们把*被设置为模板的代号,Tab键设置为模板的扩展快捷键,也可以把Tab改为Enter键,更加还原MyEclipse。

PS:(1)注意,注释模板开头不要使用/,因为设置后虽然可以更便捷的使用 * + Tab键,调用模板。但是会存在param为null的情况(原因暂时未知),如下图,需要在方法内调用才能获取参数,但这样还需要将注释复制到方法外反而使用不便。

IDEA中设置注释模板的方法第10张

(2)注释模板中的user参数是获取系统的用户(当然注释作者也可以直接写固定值,但是配置更有意思,哈哈),经常不是自己需要的作者名,可以在IDEA中进行配置。打开→IDEA的安装目录inidea64.exe.vmoptions。在最下面增加一行-Duser.name=username。

其中username就是你希望为user参数的赋值。

免责声明:文章转载自《IDEA中设置注释模板的方法》仅用于学习参考。如对内容有疑问,请及时联系本站处理。

上篇NIO:Buffer 详解推荐几个 YYDS 的 IDEA 插件,这也太秀了吧。。下篇

宿迁高防,2C2G15M,22元/月;香港BGP,2C5G5M,25元/月 雨云优惠码:MjYwNzM=

相关文章

Spark History Server配置使用

Spark history Server产生背景 以standalone运行模式为例,在运行Spark Application的时候,Spark会提供一个WEBUI列出应用程序的运行时信息;但该WEBUI随着Application的完成(成功/失败)而关闭,也就是说,Spark Application运行完(成功/失败)后,将无法查看Application...

八、设置HTTP应答头 (基础教程8)

八、设置HTTP应答头   作 者 : 仙人掌工作室            8.1 HTTP应答头概述         Web服务器的HTTP应答一般由以下几项构成:一个状态行,一个或多个应答头,一个空行,内容文档。设置HTTP应答头往往和设置状态行中的状态代码结合起来。例如,有好几个表示“文档位置已经改变”的状态代码都伴随着一个Location头,而40...

从零开始编写自己的C#框架(12)——T4模板在逻辑层中的应用(一)(附源码)

对于T4模板很多朋友都不太熟悉,它在项目开发中,会帮我们减轻很大的工作量,提升我们的开发效率,减少出错概率。所以学好T4模板的应用,对于开发人员来说是非常重要的。   园子里对于T4模板的介绍与资料已经太多了,所以在这里我就不再详细讲述基础知识了,只是说说T4模板在本框架中的具体应用与实践。   一、创建逻辑层项目         二、添加引用      ...

[代码审计]XiaoCms(后台任意文件上传至getshell,任意目录删除,会话固定漏洞)

 0x00 前言 这段时间就一直在搞代码审计了。针对自己的审计方法做一下总结,记录一下步骤。 审计没他,基础要牢,思路要清晰,姿势要多且正。 下面是自己审计的步骤,正在逐步调整,寻求效率最高。 0x01 关于 XiaoCms XiaoCms 企业建站版基于 PHP+Mysql 架构 是一款小巧、灵活、简单、易用的轻量级 cms。能满足各种企业站 博客 等...

使用Java语言开发微信公众平台(五)——获取access_token

       在前四期的文章中,我们分别学习了“环境搭建与开发接入”、“文本消息的接收与响应”、“被关注回复与关键词回复”、“图文消息的发送与响应”等环节。那么,从本篇博文开始,我们将进去更高级的开发层面,调用微信公众平台提供的各种接口。        今天,我们来学习一下微信公众平台最基础的一个接口——access_token,access_token是...

关于项目架构的一些浅谈

         最近,一直在学习和摸索关于项目架构的东东。或许说架构说得有点太大。但是还是暂且用着吧。 也看看过几个高手关于三层架构和MVC模型的文章,觉得很多东西的理解和自己的不是很一样。但是自己确实没有他们研究的深入,所以也不妄加评论。         在这里想说的是,自己幼稚的观点欢迎各位砸砖;自己绝对的言语只是针对自己的想法。         我...