在android studio 中自定义注释模板 快速输入注释,自定义代码片段,快捷键快速输入代码片段
一.设置类创建时自动生成头部注释
比如每次创建一个类自动在头部生成一个这样的头部,作为一个类的说明信息
设置方法:
点击设置—>Editor–>File and code Templates –>Includes—>File Header
代码:其中时间是自动获取的
1 2 3 4 5 6 | /** * 作者:author * 时间:${DATE}:${TIME} * 邮箱: * 说明: */ |
二.设置快速生成方法注释的两种方式
1.在studio 中自定义模板
在studio中自定义注释模板有一定的局限性,目前已知的studio的模板只能获取的时间,并不能获取返回值以及参数等信息,那是因为获取方法名的方法运行在方法内部才会生效,运行在方法外部是不能生效.
所以在方法外部用studio自定义模板的方式有一定的局限性
点击设置—>Editor–>live Templates –>点击+号 先创建1个组 再创建一个模板
编辑注释内容–>声明作用域
步骤如下:
运行方式:在方法上面,输入你定义的abbreviation 就是cnn 按回车即可:
2.javaDoc自动生成注释
如果我们想获取到方法名,参数返回值的信息,想让这些信息全部自动生成的注释里面的话,我们可以借助插件JavaDoc实现,安装插件javaDoc 安装完之后重启studio。
在方法上面输入快捷键 alt+ctrl+shift+G 即可自动生成注释,或者按alt+insert调出对话框,手动选择。
3.快速输入代码片段
当我们知道studio可以自定义模板通过快捷键快速输入的时候,我们就想快速输入代码片段可以实现吗?事实是可以的,如果有经常使用的代码,你不必每次输入,完全可以定义成模板,每次快捷键快速输入就可以了,下面是例子:还是刚才那个模板我把注释换成了一个方法,快捷键cnn可以快速输入这个方法。
再说一句
如果你对JavaDoc生成的模板如果还不满意,你还可以修改JavaDoc的模板,具体修改位置是 设置–>other—>javadoc
里面有对应的模板,模板语言使用的是一种 freemarker的标记语言,如果有感兴趣的同学可自己开发扩展;
javadoc网址:https://github.com/setial/intellij-javadocs/wiki
原文网址:点击打开链接