当前位置:首页 > 开发工具 > IDEA类和方法注释模板设置

IDEA类和方法注释模板设置

2022年09月15日 23:19:27开发工具6

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

一、设置类的注释模板

我们选择Class文件(当然你要设置接口的还也可以选择Interface文件)

  1. ${NAME}:设置类名,与下面的${NAME}一样才能获取到创建的类名

  2. TODO:代办事项的标记,一般生成类或方法都需要添加描述

  3. ${USER}、${DATE}、${TIME}:设置创建类的用户、创建的日期和时间,这些事IDEA内置的方法,还有一些其他的方法在绿色框标注的位置,比如你想添加项目名则可以使用${PROJECT_NAME}

  4. 1.0:设置版本号,一般新创建的类都是1.0版本,这里写死就可以了

IDEA类和方法注释模板设置 _ JavaClub全栈架构师技术笔记

/**
 * @package ${PACKAGE_NAME}
 * @project ${PROJECT_NAME}
 * @description [类型描述] 
 * @createTime ${DATE} ${TIME}
 * @author <a href="mail to: 457066709@qq.com" rel="nofollow">${USER}</a>
 * @version v1.0
 * @update [序号][日期YYYY-MM-DD] [更改人姓名][变更描述]
 */

如果移动代码到Includes的File Header则应用到所有文件。因为每个文件都有这句话#parse("File Header.java")。

二、设置方法的注释模板

  1. 选择File→Settings→Editor→Live Templates。点击右边的加号,选择Template Group,创建一个分组。名字任意。
    IDEA类和方法注释模板设置 _ JavaClub全栈架构师技术笔记
  2. 选中刚刚新建的group,再点击加号,选择Live Template,创建一个模板。其中:
    Abbreviation:填模板的缩写,可以使用号作为代号,方便后面调用模板。(因为我们后面会用/然后按tab建所以/*已经输入了,模板里面不需要了)

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

Template text:填写注释模板的内容。参数名使用${参数名}$的格式。(注意:注释模板开头的/不要填写,原因可以看文章末尾的解释)
IDEA类和方法注释模板设置 _ JavaClub全栈架构师技术笔记

  1. 点击模板页面最下方的警告define,来设置将模板应用于哪些场景,选择Everywhere-->Java即可。(如果曾经修改过,则显示为change而不是define,如上图)
    IDEA类和方法注释模板设置 _ JavaClub全栈架构师技术笔记

  2. 然后点击Edit variables,会读取刚刚在注释模板中的配置的参数${参数名}$。在Expression的下拉框中选择方法为其赋值。
    IDEA类和方法注释模板设置 _ JavaClub全栈架构师技术笔记

  3. 注释模板的调用。在我们的方法上方通过输入 / + * (是我们刚设置的快捷键,对照自己设的) + Tab键 (右边设置的Expand with),即先输 / 再按Tab键,就可以调用模板。因为刚刚我们把*被设置为模板的代号,Tab键设置为模板的扩展快捷键,也可以把Tab改为Enter键。

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

作者:天边的云云
来源链接:https://www.cnblogs.com/xia-na/p/15176632.html

版权声明:
1、JavaClub(https://www.javaclub.cn)以学习交流为目的,由作者投稿、网友推荐和小编整理收藏优秀的IT技术及相关内容,包括但不限于文字、图片、音频、视频、软件、程序等,其均来自互联网,本站不享有版权,版权归原作者所有。

2、本站提供的内容仅用于个人学习、研究或欣赏,以及其他非商业性或非盈利性用途,但同时应遵守著作权法及其他相关法律的规定,不得侵犯相关权利人及本网站的合法权利。
3、本网站内容原作者如不愿意在本网站刊登内容,请及时通知本站(javaclubcn@163.com),我们将第一时间核实后及时予以删除。


本文链接:https://www.javaclub.cn/tool/41529.html

标签: IDEA
分享给朋友:

“IDEA类和方法注释模板设置” 的相关文章

Mavan的配置,以及与IDEA版本不一致,解决办法

Mavan的配置,以及与IDEA版本不一致,解决办法

目录 1.mavan的环境变量的配置 1.1 下载maven 3.1.1 1.2、配置Maven环境变量 1.3检...

IntelliJ IDEA安装教程(超详细)

IntelliJ IDEA安装教程(超详细)

IDEA安装教程目录 一、JDK的彻底卸载(选做) 二、JDK的安装 三、IDEA的安装 四、IDEA的“扩展”教程 五、代码测试 六、Error:Cannot determine path to 'to...

手把手教你JDK+IDEA的安装和环境配置

手把手教你JDK+IDEA的安装和环境配置

                   目录 1.先安装JDK  1.1 查看电脑是多少位的系统 1.2 安装和电脑系统相同位的JDK...

IDEA技巧:如何根据注释生成swagger注解

IDEA技巧:如何根据注释生成swagger注解

相信大家在进行java项目开发,肯定会接触到swagger的,一款动态生成api文档的神奇,只需要在api上面加上注解,就可以生成文档,现在我简单介绍下swagger的快速入门,最后再说下如何根据注释快速生成这些烦人的注解。 ​ swagger日常...

如何将idea项目上传到Git

如何将idea项目上传到Git

Git是一款免费的分布式版本控制工具。每个人的电脑都是一个完整的版本库,那么我们该如何将一个java项目上传到Git呢? 一、准备工作 1、Git下载及安装 https://jingyan.baidu.com/article/7f766dafba84f04101...

IDEA 添加classPath

IDEA 添加classPath

OK,成功把src/main/resources/spring添加至classpath! 作者:t95921 来源链接:https://blog.csdn.net/t95921/article/details/53585225...

IDEA底部工具栏调出Version Control(Git)

IDEA底部工具栏调出Version Control(Git)

IDEA底部工具栏调出Version Control(Git) 步骤:VCS–>Browse VCS Repository–>Show GIt Repository … 作者:sunday2018 来源链接:...

IDEA 配置环境变量

IDEA 配置环境变量

作者:基咯咯 来源链接:https://blog.csdn.net/u010180815/article/details/105219332...

IDEA里String等基本类型显示红色的处理(Java)

IDEA里String等基本类型显示红色的处理(Java)

今天导入新项目时候发现String等类型都爆红,说明JDK配置出问题,解决如下: IDEA中,View-Tollbar打上对勾(也可以使用快捷键“Ctrl+Alt+Shift+s”),打开“Project Structure”窗口 如上图,点击“Project...

idea使用指南

idea使用指南

给一个类添加  private static final long serialVersionUID = -6026705857561800365L; // 鼠标放到类名处, ALT + 回车即可 关于强转 (CrcWorkExperienceAfter...

发表评论

访客

◎欢迎参与讨论,请在这里发表您的看法和观点。