前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >IDEA 设置类和方法注释模板

IDEA 设置类和方法注释模板

作者头像
Remember_Ray
发布2020-03-09 13:33:59
2.5K0
发布2020-03-09 13:33:59
举报
文章被收录于专栏:Ray学习笔记

设置类模板

位置

File -> Settings -> Editor -> File and Code Templates

选择 Includes

创建文件头

点击 “+”,改名为 File Header,内容如下

代码语言:javascript
复制
/**
 * @Description: ${DESCRIPTION}
 *
 * @Author ${USER}
 * @Date ${DATE} ${TIME}
 * @Version 1.0
 */

设置方法注解模板

位置

File -> Settings -> Editor -> Live Templates

创建组

点击 “+”,Create New Group,输入【自定义组名,例如 userDefine】

创建模板

点击 “+”,Live Template

配置模板

Abbreviation:设置模板名称,建议就是 *

Description:模板描述,可选

Template text:模板,注意开头是没有 /*

代码语言:javascript
复制
*
 * @Description: $END$
 * @Author: $user$
 * @Date: $date$ $time$
 $param$
 $return$
 **/

设置模板的应用场景

点击模板页面最下方的警告,来设置将模板应用于那些场景,一般选择 EveryWhere -> Java 即可

设置参数的获取方式

点击 Edit variables

Name

Expression

Default value

Skip if defined

user

user()

date

date()

time

time()

param

如下

return

如下

Skip if defined

建议打勾,不然每次创建,都会先跳到上面每个参数,优先修改此参数

param Default value

代码语言:javascript
复制
groovyScript("if(\"${_1}\".length() == 2) {return '';} else {def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList();for(i = 0; i < params.size(); i++) {if(i==0){result+='* @param ' + params[i] + ': '}else{result+='\\n' + ' * @param ' + params[i] + ': '}}; return result;}", methodParameters());

return Default value

代码语言:javascript
复制
groovyScript("def returnType = \"${_1}\"; def result = '* @return: ' + returnType; return result;", methodReturnType());
本文参与 腾讯云自媒体同步曝光计划,分享自作者个人站点/博客。
原始发表:2020-03-06,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 设置类模板
    • 位置
      • 创建文件头
      • 设置方法注解模板
        • 位置
          • 创建组
            • 创建模板
              • 配置模板
                • 设置模板的应用场景
                  • 设置参数的获取方式
                    • Skip if defined
                    • param Default value
                    • return Default value
                领券
                问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档