[IDEA]IDEA设置注释模板

时间:2023-03-09 15:56:14
[IDEA]IDEA设置注释模板

IDEA的注释模板有类注释模板和方法注释模板两种,下面分别介绍:

一、类注释模板

菜单路径:File->Settings->Editor->File and Code Templates

[IDEA]IDEA设置注释模板

类模板代码:

/**
*@description:
*@projectName:${PROJECT_NAME}
*@see:${PACKAGE_NAME}
*@author:郑晓龙
*@createTime:${DATE} ${TIME}
*@version:1.0
*/

二、方法注释模板

菜单路径:File->Settings->Editor->Live Templates

方法注释模板有3个操作:

1、新建模板组

2、设置模板

3、编辑变量

下面我将按照这个顺序图文并茂进行展示

1、新建模板组

点击下图中的Template Group来新建模板组,命名为MyTemplateGroup

[IDEA]IDEA设置注释模板

[IDEA]IDEA设置注释模板

2、设置模板

在该模板组下新建模板并填充模板内容(Live Template),

[IDEA]IDEA设置注释模板

方法模板内容:

*
* description
* param $param$
* return $return$
* author 郑晓龙
* createTime $date$ $time$
**/

3、编辑变量

[IDEA]IDEA设置注释模板

保存后,编写类和方法进行测试

[IDEA]IDEA设置注释模板

注意:这里的类注释在新建类时会自动添加,方法注释需要通过输入 /**  + 回车的方式手工输入