Intellij Idea自动添加注释的方法

程序媛阿历终于要写第一篇关于开发的文章了!!!

阿历用Intellij Idea开发,版本是Ultimate 2017.2.2。这周写代码的时候,发现编辑注释很麻烦,不但要写注释符,还要写名字、日期、描述等等,很繁琐。工具是用来提高效率的,为了提高开发的效率,我去网上搜索了Intellij Idea自动添加注释的方法。因为现有总结不够全面,而且有的方法对于我的版本不太奏效,于是我整理了自动添加注释的方法(很抱歉忘记记录参考的网址了),亲测有效。

自动添加注释有两类方法:1、创建文件时,idea自动生成注释;2、在编辑源文件时,插入注释。下面具体介绍。

1、创建文件时,idea自动生成注释

第一种很简单,一张图就可以说清楚。过程是,在设置中找到“File and Code Templates”,在类文件的模板中添加注释。具体如下图(图1)所示:

(1)首先打开设置,点File,Settings即可打开下图界面,或者直接用快捷键“Ctrl+Alt+S”(我特别喜欢用快捷键^^)打开设计界面。

(2)在搜索框中输入“File and Code Templates”,打开“File and Code Templates”。

(3)在右侧的Files一栏中,找到Class,编辑注释。下面的Description介绍了可以使用的系统变量,按需索取。

(4)最后点击Apply和OK就完成啦。

图1 新建文件,自动生成注释

至此,你可以新建一个class文件,测试一下啦!

2、在编辑源文件时,插入注释

这个步骤有点多,但是同样很简单。大致过程是打开“Live Templates”,新建我们自己的template,编辑注释文本,定义应用文件,编辑变量。具体看下面:

(1)打开Settings,找到“Live Templates”,点右侧“+”,新建一个“Template Group...”,见图2.1、2.2。

图2.1 新建Template Group
图2.2 输入Group名字

(2)选中刚建好的Group,再点右侧“+”,创建一个“Live Template”,见图2.3。

图2.3 新建Live Template

(3)编辑Template的缩写(插入注释时用),在Template text中编辑注释模板(如图2.4)。注意变量的定义方式,用两个$包围变量名,例如变量user的定义为$user$。

(4)定义应用这个Template的环境,点击Define。我选择了Java(如图2.5)。

图2.4 编辑注释
图2.5 选择应用场景

(5)编辑变量,点击“Edit variables”,如图2.6、2.7。给变量选择表达式或者定义默认值。

图2.6 编辑变量
图2.7 选择表达式或设置默认值

(6)最后点击“Apply”和“OK”(图),就完成啦。

图2.8 完成设置

试试这个方法吧(图2.9、2.10):在class源文件编辑器中,输入步骤(3)设置的模板缩写,例如我设置的是“cmmt”。Idea会显示提示,然后回车,就插入注释了。

图2.9 测试
图2.10 效果


结语:

成功设置了自动添加注释,感觉还是很神奇的,佩服开发工具的工程师。

虽然研究设置花费一定的时间,但是成功之后用得就很爽了,简直是一劳永逸!

以后会尽量多写跟技术相关的文章~~毕竟是个程序媛,哈哈。加油!

希望本文对你有帮助。

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

推荐阅读更多精彩内容