Android Studio 代码注释模板设置指南

一、基础注释模板（类 / 接口 / 枚举）

1. 进入配置界面

File → Settings → Editor → File and Code Templates → Includes，选择 File Header（全局生效）。

2. 配置模板内容（示例）

java

运行

/**

 * @description: ${DESCRIPTION}

 * @author: ${USER}

 * @date: ${DATE} ${TIME}

 * @version: 1.0

 */

• 变量说明：

${DESCRIPTION}：类描述（需手动输入），${USER}：系统用户名，${DATE}/${TIME}：创建时间（自动填充）。

3. 生效方式

新建类 / 接口时，模板会自动插入到文件头部。

二、方法注释模板（Live Template）

1. 进入配置界面

File → Settings → Editor → Live Templates，点击 + 新建模板组（如 CustomTemplates），再在组内新建模板。

2. 模板配置

配置项 内容

Abbreviation 触发快捷键（如 cmt）

Description 模板描述（如 “方法注释模板”）

Template Text 注释模板（见下方示例）

Applicable Context 勾选 Java → Declaration（仅在方法声明处生效）

3. 模板内容（带自动参数）

java

运行

/**

 * @description: $description$

 * @param: $params$

 * @return: $return$

 * @author: $user$

 * @date: $date$ $time$

 */

4. 绑定变量（关键步骤）

点击 Edit Variables，为变量设置取值：

• params：选择 groovyScript，输入代码：

methodParameters().collect { it + " " + it.type.name() }.join(", ")（自动获取参数名 + 类型）

• return：选择 methodReturnType()（自动获取返回值类型）

• user/date/time：直接选择对应系统变量

• description：留空（手动输入）

5. 生效方式

在方法定义行上方输入 cmt，按 Tab 键触发。

三、其他实用配置

1. 单行注释格式化

File → Settings → Editor → Code Style → Java → Comments：

• 勾选 Line comment at first column（单行注释靠左对齐）

• 配置 Line comment spacing（注释与代码间距）

2. 模板导入 / 导出

配置完成后，点击 Export Template 保存为 .xml，换设备时 Import Template 即可复用。

四、注意事项

1. 方法注释需在方法声明行上方触发，否则无法自动获取参数 / 返回值；

2. 若变量未自动填充，检查 Applicable Context 是否正确勾选；

3. 自定义变量可通过 groovyScript 扩展（如获取包名、作者邮箱等）。