Android Studio 配置系列（一）：自定义代码注释

1. 自定义文件头注释

---

依次点击File -> Settings ->Editor ->File and Code Templates，在详细展示窗口点击includes选项卡，找到FileHeader点击，在编辑窗口输入自定义的注释模板即可。

示例：
/*

 * -----------------------------------------------------------------

 * Copyright (C) 2014-2016, by your company, All rights reserved.

 * -----------------------------------------------------------------

 *

 * File: ${NAME}.java

 * Author: ${USER}

 * Version: V100R001C01

 * Create: ${DATE} ${TIME}

 *

 * Changes (from ${DATE})

 * -----------------------------------------------------------------

 * ${DATE} : Create ${NAME}.java (${USER});

 * -----------------------------------------------------------------

 */

通常我们可以使用如下的通配符：

${PACKAGE_NAME}         新建文件所在包名

${USER}             当前系统登录的用户名

${DATE}             创建文件时当前系统的日期（格式：yyyy/MM/dd）

${TIME}             创建文件时当前系统的时间（格式：hh:mm）

${YEAR}             创建文件时当前系统的年份

${MONTH}                创建文件时当前系统的月份
 
${MONTH_NAME_SHORT} 当前月份的前三位字符缩写，例如: Jan, Feb, etc.

${MONTH_NAME_FULL}      当前月份的字母全写，例如: January, February, etc.

${DAY}                  当前时间所属月份的天数

${HOUR}             当前的小时数

${MINUTE}               当前的分钟数

${PROJECT_NAME}     当前的项目名

${NAME}             当前的文件名

做完这些点击ok即可。

2. 添加代码块自定义注释模板

---

• 依次点击File -> Settings ->Editor ->Live Templates

• 在详细展示窗口右侧点击

  
  

• 键入组名字

  
  
  

  ，输入完成后点击ok

• 在详细展示列表找到刚刚保存的那个组并选中

• 在详细展示窗口右侧点击

  
  

• 在abbreviation处输入缩写，使用时候需要用到此缩写，description处输入模板描述

• Template text处输入注释模板

/**
 - @Description:  $desc$
 - @Author:  $user$
 - @Time:  $date$ $time$
 */

• 点击Edit variables,进行如下编辑

• 点击详细展示窗口下方的change按钮，选择注释模板的使用范围，此处我们选择java declaration即可。

• 做完这些保存即可。

• 使用方法：在代码中需要添加注释的地方输入刚刚的缩写字母，就会有提示了，

按下enter后就会自动填写了注释模板