Android创建类、方法的注释模板

创建类的注释模板

• File–>setting–>Editor–>Live templates–>右边+号–>点击Template Group
  

命名为custom，点击ok，

• 选中custom，再次点击右边+号，这次选第一项
  

• 在Abbreviation输入cmt（相当于快捷键），然后在Template Text输入下面文本，即注释模板

/**
 * 创建日期：$date$ $time$
 * @author Yuan
 * @version 1.0
 * 文件名称： $file_name$
 * 类说明：
 */

• 要设置你这个cmt快捷键在哪里生效，我的选择是在声明的时候生效，也即你在方法名上打cmt加回车就可以了。点击Define选择如图
  
• Template text定义了三个变量 date,time, file_name，需要生成日期时间、文件名，所以我们要编辑这三个变量，点击Edit variables，第二列expression都写上函数表达式，第四列都打上对勾
  
  改为Enter。
  

OK，点击Apply应用

• 测试
  在一个文件中输入cmt，直接回车即可
  
  结果如图：
  

创建方法的注释模板

同上，方法的注释模板在custom下新建，改个快捷键名（例如fcmt）和自己需要的模板即可，但是，方法的注释快捷键的使用有所不同，因为按照上面的步骤来，方法的名字，参数和返回类型获取不到。
来看一下我的方法注释模板如下

/**
 * 创建日期：$date$ $time$
 * @author Yuan
 * 方法名称： $methodName$
 * 方法说明：
 * @param:$param$
 * @return:$return$
 */

编辑变量

测试发现，按着以上步骤来无法获得方法的名称参数和返回值。

但是系统里设置的方法注释快捷键可以获得如图所示（添加方法的快捷键见：https://blog.youkuaiyun.com/dream_summer/article/details/107647283)）

但是系统给的不是我们想要的注释模板，所以我们结合一下，
使用快捷键的方法为：
在方法名前先输入/*再输入我们模板的快捷键名fcmt再回车即可

结果如下，获得了方法的相关参数

参数换行
这样参数是个数组，我想要给每个参数加注释很不方便，需要给参数换行。
编辑变量的时候将参数的函数表达式换为如下代码

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

模板换为

/**
 * 创建日期：$date$ $time$
 * @author Yuan
 * 方法名称： $methodName$
 * 方法说明：
 $param$
 * @return:$return$
 */

再次测试结果如图所示：

化简快捷键

到这里又觉得这个快捷键的使用太麻烦了，都快称不上快捷键了。所以有个简单的方法就是可以直接给方法注释模板命名为*,这样直接在方法前输入/**回车可以