IDEA 设置注释模板

在进行开发的时候,尤其是在公司进行代码开发的时候,在你的代码上一般都要加上注释,常见的就是你的名称、创建日期、类的描述等,name如何去定义自己的注释模板呢?

设置类的模板

IDEA 中可以进行自己模板的定义。按照File--> Settings --> Editer-->>File and Code Templates-->Files中打开设置页面:

image.png

这里我们主要关注 Class、Interface、Enum 者几个模板的设置,因为我们平时主要用到着三个。选中Class 可以看到右面的默认的模板,我们可以这样去替换他:

/**
 * @Auther: ${USER}
 * @Date: ${DATE} ${HOUR}:${MINUTE}
 * @Description: ${NAME}
 * @Version 1.0.0
 */
image.png

其他的两个设置相同,然后点击OK就可以。

测试一下

image.png

发现是可以的。

设置方法的注释

IDEA没有可以直接设置方法注释模板的地方,可以借用Live Templates基本实现,步骤如下。

首先创建模板组

选择File–>Settings–>Editor–>Live Templates,先选择右侧绿色加号新建一个自己的模板组,如图,命名为methodTemplate


image.png

选中已建好的组,选择右侧绿色加号新建模板,如下图。

image.png

填写的模板为
注意这里的是*而不是 /*开头,因为这样才能比较好的使用我们定义的去实现模板,不然的话,最后的模板会有问题,很丑。

*
 *
 * @description: 
 * @param: $param$
 * @return: $return$
 * @date: $date$ 
 */
image.png

点击那个Define,然后勾选使用的场景,这里我们勾选Java就行了。


image.png
image.png

然后点击Edit variables 进行如下的设置:


image.png

最后点击OK 就行了。

补充说明

image.png

这里的Expand with 是你输入快捷键后的按键,也就是你输入/**之后,你要按Tab键才能使用上面设置的模板,当然这个键可以你自己去设置。

测试验证

image.png

成功!!!

结语

如果本文章对你有所帮助的话,请帮忙点个赞!!!

©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 230,106评论 6 542
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 99,441评论 3 429
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 178,211评论 0 383
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 63,736评论 1 317
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 72,475评论 6 412
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 55,834评论 1 328
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 43,829评论 3 446
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 43,009评论 0 290
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 49,559评论 1 335
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 41,306评论 3 358
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 43,516评论 1 374
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 39,038评论 5 363
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 44,728评论 3 348
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 35,132评论 0 28
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 36,443评论 1 295
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 52,249评论 3 399
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 48,484评论 2 379