AndroidStudio自定义注释

设置类创建时自动生成头部注释

• 比如每次创建一个类自动在头部生成一个这样的头部,作为一个类的说明信息


• 设置方法

点击设置—>Editor–>File and code Templates –>Includes—>File Header
代码：其中时间是自动获取的

/**
 * Description: 
 * Data：${DATE}-${TIME}
 * Blog：www.qiuchengjia.cn
 * Author: qiu
 */

• 效果和步骤


设置快速生成方法注释的两种方式

在studio 中自定义模板

• 在studio中自定义注释模板有一定的局限性，目前已知的studio的模板只能获取的时间，并不能获取返回值以及参数等信息，那是因为获取方法名的方法运行在方法内部才会生效,运行在方法外部是不能生效.
  所以在方法外部用studio自定义模板的方式有一定的局限性

• 模板

/**
 * Description:$Method$
 * Blog: www.qiuchengjia.cn
 * Data: $Date$ $Time$
 * @author: qiu
 */

• 点击设置—>Editor–>live Templates –>点击+号 先创建1个组 再创建一个模板
  编辑注释内容–>声明作用域


javaDoc自动生成注释

• 如果我们想获取到方法名，参数返回值的信息，想让这些信息全部自动生成的注释里面的话，我们可以借助插件JavaDoc实现，安装插件javaDoc 安装完之后重启studio

效果


方法配置

• 我这儿拿method的来举例。我给每个方法的注解加 一个 作者以及时间

• @author qiu 博客：www.qiuchengjia.cn 时间：${.now?string[“yyyy-MM-dd”]}\n

• 原始配置

/**\n
 * ${name}<#if isNotVoid> ${return}</#if>.\n
<#if element.typeParameters?has_content>         * \n
</#if>