IDEA设置类和方法注释模板(非常详细实用)
IDEA自带的注释模板不是太好用,我本人到网上搜集了很多资料系统的整理了一下制作了一份比较完整的模板来分享给大家,我不是专业玩博客的,写这篇文章只是为了让大家省事。
一、首先我们来设置IDEA中类的模板:(IDEA中在创建类时会自动给添加注释)
1、File-->settings-->Editor-->File and Code Templates-->Files
我们选择Class文件,可以看到创建Class时引入了一个参数"File Header.java"。对应的是Files旁边的Includes→File Header文件。
2、File Header里就是创建类时的注释模板,下面Description中有描述一些可以配置的参数,可以根据自己需要选用。
附上源码:
/** *TODO * *@author:${USER} *@date: ${DATE} */ 复制代码
效果图展示:
二、设置方法的注释模板
1、选择File→Settings→Editor→Live Templates。点击右边的加号,选择Template Group,创建一个分组。
2、再点击加号,选择Live Template,创建一个模板。其中:
Abbreviation:填模板的缩写,可以使用*号作为代号,方便后面调用模板。
Options→Expand with:填注释模板的扩展快捷键,根据使用习惯,这里使用默认的Tab。
Template text:填写注释模板的内容。参数名使用${参数名}$
的格式。(注意:注释模板开头的/不要填写)
3、点击模板页面最下方的警告define,来设置将模板应用于哪些场景,选择Everywhere-->Java即可。
4、然后点击Edit variables,会读取刚刚在注释模板中的配置的参数${参数名}$
。在Expression的下拉框中选择方法为其赋值。
效果图展示:
附上源码:
* * TODO * * @Param $param$ * @return $return$ */
作者:Davie8023
链接:https://juejin.cn/post/6847902215558922253