Android Studio添加自定义注释模板

原文链接:https://blog.csdn.net/ZJW19890602/article/details/108480524

设置方法:

1,设置路径:进入Android Studio的Settings->Editor->Live Templates路径下,点击后边的"+"按钮,创建一个自定义的Template Group (如果之前已经创建过自定义模板组则可不用再创建,直接使用即可),该Group的名字可以随便自定义(此处命名为“ZJW Custom Template”)。创建Group后再在该Group下创建一个Live Template,缩略词命名为“cdoc”,注释为“class doc”(表示这是类的注释文档,这些命名都可以自己随便自定义)。该模板的其他部分的设置详见下面步骤;

2,点击上一个步创建的类注释模板cdoc,然后在Template text部分输入如下内容 (此部分内容作用就是定义注释的格式,根据个人需要自定义):

================== 分割线 ======================

/**

*

* @author Administor

* @since $date$ $time$

*/

================== 分割线 ======================

如下图所示:


 
3,点击Edit variables按钮,在Edit Template Variables界面分别设置参数date的Expression为:date();设置参数time的Expression为: time()。需注意此处每次完成表达式的输入后都需点击Enter键才能确认输入。设置完成后点击ok即可。

  备注:这个步骤是给上一步输入的内容中的两个参数date和time添加赋值表达式,date()表达式的作用是获取创建类时的日期,格式为:年/月/日(示例:2020/9/8);time的作用是获取创建类时的时间,格式为:小时:分(示例:22:18)。 如下图:


4,在Expand with选项中选择适合自己的快捷键,一般选为:Enter。该快捷键作用是在代码中输入注释模板缩写词后按下快捷键能自动输出对应注释模板内容。如下图:


5,点击下图红框处的Define,选择该注释模板需要应用的编程语言(Android开发一般选择Java或Kotlin即可),如下图所示:


6,上述5个步骤设置完成后应该类似于下图所示。最后依次点击Apply和OK按钮即可完成该类注释模板的设置。


7,最后,在代码中导入该类注释模板的方法:

 在类声明代码行的上一行空白处输入该注释的缩略词:cdoc,然后点击Enter键回车,该注释模板就应该能自动输出。

效果如下图:


二,给方法添加自定义注释模板:

    自定义方法的注释模板与自定义类的注释模板方法类似,不同于的地方在于自定义方法的注释模板需要考虑在注释中自动获取方法形参的类型和名称及方法返回值,这些功能的实现需要利用groovyScript语言。

设置方法:

1,设置路径:设置路径同自定义类的注释模板,具体参考上述步骤1即可。假设已经创建了模板组(自定义名称:ZJW Custom Template),则在该模板组中再创建一个Live Template,缩略词命名为“mdoc”,注释命名为“method doc”(表示这是一个方法注释模板),命名均可自己随便自定义。

2,点击上一个步创建的方法注释模板mdoc,然后在Template text部分输入如下内容 (此部分内容作用就是定义注释的格式,根据个人需要自定义):

================== 分割线 ======================

*

* $desc$

* $param$

$return$

* @author Administor

* @createTime $date$ $time$

*/

================== 分割线 ======================

如下图所示:


3,点击Edit variables按钮,在Edit Template Variables界面分别进行如下设置:

参数param的Default value为:

groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {if(params[i] == '') return result;if(i==0) result += '\\n'; result+=' * @param ' + params[i] + ((i < params.size() - 1) ? '\\n' : '')}; return result", methodParameters())

参数return的Default value为:

groovyScript("def returnType = \"${_1}\"; def result = ' * @return ' + returnType; return result;", methodReturnType());

参数date的Expression为:date()

参数time的Expression为: time()

备注:

(1) 需注意此处每次完成表达式的输入后都需点击Enter键才能确认输入。设置完成后点击ok即可。

(2) 这个步骤是给上一步输入的内容中的4个参数param、return、date、time添加赋值表达式。

上述内容设置完成后将如下图:


4,需要将Expand with选项选中为适合自己的快捷键,一般选为:Enter。该快捷键作用是在输入注释模板缩写词后展开输出注释模板的详细内容。


5,点击下图红框处的Define,选择该注释模板需要应用的编程语言(Android开发一般选择Java或Kotlin即可),如下图所示:


6,上述5个步骤设置完成后应该类似于下图所示。最后依次点击Apply和OK按钮即可完成该类注释模板的设置。


7,最后,在代码中导入该方法注释模板的方法:

在方法声明代码行的上一行空白处输入:/*cdoc, 然后点击Enter键即可自动导入注释。(注意:方法注释模板缩写词"cdoc"前面必须先输入/*才能使得ideal生效,groovyScript代码中定义的methodParameters()和methodReturnType()两个方法才会有作用)

效果如下图:


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

推荐阅读更多精彩内容