Android Studio添加自定义注释模板

     日常开发过程中给代码添加注释无疑是个好习惯，我们在使用Android Studio进行Android代码开发过程中经常需要给类或方法添加注释，添加一般的注释是一件很容易的事情，但如果想添加自定义格式的注释就不是那么容易了，下面该文将详细介绍如何在Android Studio中给类和方法分别添加自定义注释模板。

一，给类添加自定义注释模板：

设置方法：

1，设置路径：进入Android Studio的Settings->Editor->Live Templates路径下，点击后边的"+"按钮，创建一个自定义的Template Group (如果之前已经创建过自定义模板组则可不用再创建，直接使用即可)，该Group的名字可以随便自定义(此处命名为“ZJW Custom Template”)。创建Group后再在该Group下创建一个Live Template，缩略词命名为“cdoc”，注释为“class doc”(表示这是类的注释文档，这些命名都可以自己随便自定义)。该模板的其他部分的设置详见下面步骤；

2，点击上一个步创建的类注释模板cdoc，然后在Template text部分输入如下内容 (此部分内容作用就是定义注释的格式，根据个人需要自定义)：

================== 分割线 ======================

/**

*

* @author Administor

* @since $date$ $time$

*/

================== 分割线 ======================

如下图所示：

3，点击Edit variables按钮，在Edit Template Variables界面分别设置参数date的Expression为：date()；设置参数time的Expression为: time()。需注意此处每次完成表达式的输入后都需点击Enter键才能确认输入。设置完成后点击ok即可。

  备注：这个步骤是给上一步输入的内容中的两个参数date和time添加赋值表达式，date()表达式的作用是获取创建类时的日期，格式为：年/月/日(示例：2020/9/8)；time的作用是获取创建类时的时间，格式为：小时:分(示例：22:18)。 如下图：

4，在Expand with选项中选择适合自己的快捷键，一般选为：Enter。该快捷键作用是在代码中输入注释模板缩写词后按下快捷键能自动输出对应注释模板内容。如下图：

5，点击下图红框处的Define，选择该注释模板需要应用的编程语言(Android开发一般选择Java或Kotlin即可)，如下图所示：

接上图：

6，上述5个步骤设置完成后应该类似于下图所示。最后依次点击Apply和OK按钮即可完成该类注释模板的设置。

7，最后，在代码中导入该类注释模板的方法：

 在类声明代码行的上一行空白处输入该注释的缩略词：cdoc，然后点击Enter键回车，该注释模板就应该能自动输出。

效果如下图：

 

二，给方法添加自定义注释模板：

     自定义方法的注释模板与自定义类的注释模板方法类似，不同于的地方在于自定义方法的注释模板需要考虑在注释中自动获取方法形参的类型和名称及方法返回值，这些功能的实现需要利用groovyScript语言。

设置方法：

1，设置路径：设置路径同自定义类的注释模板，具体参考上述步骤1即可。假设已经创建了模板组(自定义名称：ZJW Custom Template)，则在该模板组中再创建一个Live Template，缩略词命名为“mdoc”，注释命名为“method doc”（表示这是一个方法注释模板），命名均可自己随便自定义。

2，点击上一个步创建的方法注释模板mdoc，然后在Template text部分输入如下内容 (此部分内容作用就是定义注释的格式，根据个人需要自定义)：

================== 分割线 ======================

*

* $desc$

* $param$

$return$

* @author Administor

* @createTime $date$ $time$

*/

================== 分割线 ======================

如下图所示：

3，点击Edit variables按钮，在Edit Template Variables界面分别进行如下设置：

参数param的Default value为：

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

参数return的Default value为:

groovyScript("def returnType = \"${_1}\"; def result = ' * @return ' + returnType; return result;", methodReturnType());

参数date的Expression为：date()

参数time的Expression为: time()

备注：

(1) 需注意此处每次完成表达式的输入后都需点击Enter键才能确认输入。设置完成后点击ok即可。

(2) 这个步骤是给上一步输入的内容中的4个参数param、return、date、time添加赋值表达式。

上述内容设置完成后将如下图：

4，需要将Expand with选项选中为适合自己的快捷键，一般选为：Enter。该快捷键作用是在输入注释模板缩写词后展开输出注释模板的详细内容。

5，点击下图红框处的Define，选择该注释模板需要应用的编程语言(Android开发一般选择Java或Kotlin即可)，如下图所示：

6，上述5个步骤设置完成后应该类似于下图所示。最后依次点击Apply和OK按钮即可完成该类注释模板的设置。

7，最后，在代码中导入该方法注释模板的方法：

在方法声明代码行的上一行空白处输入：/*cdoc, 然后点击Enter键即可自动导入注释。（注意：方法注释模板缩写词"cdoc"前面必须先输入/*才能使得ideal生效，groovyScript代码中定义的methodParameters()和methodReturnType()两个方法才会有作用）

效果如下图：

 

参考文章：

1，idea设置方法注释: https://www.jianshu.com/p/2b17c3879879

2，IDEA 配置方法注释@param时自动参数的问题:https://blog.csdn.net/qq_34533072/article/details/80830738

3，Android Studio或Idea中必备插件、自定义注释和Javadoc:https://blog.csdn.net/jin110502116/article/details/90647261