自定义 Android Studio 注释模板

Android Studio 配置注释模板有两种方式：

File and Code Templates

Live Templates

先来说 File and Code Templates：用来配置文件和代码模板，即文件在创建的时候自动会按文件模板生成代码注释。

下面来演示一下如何自动生成 Java 类注释。

依次打开下面这个菜单：

Editor > File and Code Templates > files

 

这里面自带了很多文件的注释模板，但是需要自己设置，上图 class 里面的内容就是自带的，看里面这句代码：

#parse("File Header.java")

这句代码它指向 File Header。

 再依次打开下面这个菜单：

Editor > File and Code Templates > File Header

其实 Includes 就是前面 Files 模板里面 parse 引用的片段而已。File Header 默认是空的，我们在里面编辑模板即可，支持一些预定义的变量，如：DATE、TIME、USER 等，如上图右下部分，图示显示不全，有兴趣的可以打开编译器自行查看。

配置完后，随便创建一个类就会自动带上注释。如下图：

模板：

/**   
 * @Description:    java类作用描述 
 * @Author:         作者名
 * @Email:          邮箱  
 * @CreateDate:     ${DATE} ${TIME}
 * @UpdateRemark:   更新说明：
 * @Version:        1.0
 * PS: You can change the world with code! Don't give up!
 */

接下来我们说说 Live Templates：配置动态模板，可以在指定位置使用缩写字母自动生成注释。

首先打开 Live Templates 菜单，创建方法自定义注释：

 依照上图我们发现右上角有个 + 号，点击选择 Live Template 添加一个动态模板，依次配置下面的内容。

abbreviation： 模板缩写

Description： 模板描述

Template Text： 模板内容

如下图所示：

按照下图中的方式去关联变量，Template Text 里面美元符号包起来的是变量，需要点击 Edit variable 按钮来设置这些变量。

 接着就是设置模板使用的场景，如以下所示，点击 Define 链接，设置该模板只能在 Java 语言下使用。

 模板：

*
 * description: $description$ 
 * version: 1.0 
 * createDate: $date$ $time$ 
 * author: 作者
 *
$params$
        * @return $return$
        */ 

注意：方法里面的 params 变量需要用以下 Groovy 表达式来配置，否则无法获取。

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\\b' : '')}; return result", methodParameters()) 

类注释和方法注释配置一致，这里就不在多说了。

推荐：巧用Live Template，不仅能提升AS开发效率，还能装逼

参考：https://www.jianshu.com/p/812d06702437

          https://www.cnblogs.com/linfenghp/p/5561639.html