自定义代码注释模板

当开发者使用Android Studio创建类、方法等代码时，可以通过代码模板，增加相应的注释。这样既能统一风格，也能减少工作量。

方法注释

在Android Studio中，系统给开发者提供了默认的方法注释模板在方法名上一行输入“/**”，再按Enter键确认，即可获取方法的注释代码，如图3.66所示。

图3.66　方法注释

通过这种方式，可以快速生成方法注释。同时，系统会自动生成参数、返回值，并将光标定位到方法描述区域。一般情况下，使用这种方式就可以满足大部分的方法注释需求了。

但和Android一样，Android Studio也提供了强大的自定义功能，开发者可以根据自己的需要随意生成想要的注释模板。要自定义一个方法模板，首先需要打开设置，选择Live Templates，如图3.67所示。

图3.67　选择方法模板

接下来，点击右边栏的加号，选择增加一个Template Group，并在该Group下新增一个Template，如图3.68所示。

图3.68　自定义方法模板

选中自定义的注释模板，如图3.68所示的“ma”，在下方的编辑区域中进行注释代码的编辑，笔者所编辑的效果如图3.69所示。

其中，使用“$”符号包裹的即为变量，可以通过右边的按钮“Edit variables”来进行修改，如图3.70所示。

图3.69　编辑方法模板

图3.70　方法模板变量

这里给变量date提供了date（）函数的赋值，即获取当前系统时间，并动态赋值给date变量。最后，点击下方的change连接，选择在何时对该注释进行生效，如图3.71所示。

图3.71　申明方法模板

一般来说，选择Declaration即可，表明在申明时即生效。通过这样的配置后，在方法前输入“ma”即可弹出该模板，按Enter键后确认输入，如图3.72所示。

图3.72　使用代码模板

通过这种方式，开发者可以随意修改、新增自己的代码模板，非常的方便。

文件、类注释

当系统生成一个类、接口等文件时，系统会默认生成一些代码和注释，如图3.73所示。

图3.73　文件模板

和方法注释一样，开发者对这些注释同样可以完全自定义。

首先，进入设置界面，选择“File and Code Templates”即可打开代码注释模板界面，如图3.74所示。

图3.74　配置文件模板

在这里，Android Studio已经内置了一些代码的模板，开发者可以根据自己的需要，修改这些模板或者新增新的代码模板。

接下来，选择Include标签。这里的模板，类似于在布局文件中被Include进来的布局，即一些通用模板。例如笔者配置的两个模板，如图3.75和图3.76所示。

图3.75　编辑文件模板1

图3.76　编辑文件模板2

有了这两个相同模板，开发者就可以组合这些模板来创建新的完整的类、文件模板。例如，在Files标签中新创建一个模板文件，命名为MyClass并设置代码模板，如图3.77所示。

图3.77　自定义文件模板

代码中所引用的就是前面笔者在Include标签中所增加的那几个通用模板。要使用自定义的模板也非常方便，只需要在单击鼠标右键选择New的时候，选择自定义的模板代码即可，如图3.78所示。

图3.78　使用自定义模板

选择相应的模板后，生成的代码如图3.79所示。

图3.79　生成文件模板

有了这个示例，大家还可以创建更多的代码模板，例如笔者创建的MyActivity模板，如图3.80所示。

图3.80　配置类文件模板

生成的代码如图3.81所示。

图3.81　生成类文件模板

举一反三，开发者可以为自己的开发提供常用的代码模板，增加开发的效率。那么除了这些类和文件的模板，实际上在Android中有很多代码都是类似的。例如Adapter、单例这样的代码，因此为这些可复用的代码增加模板是非常有用的，笔者这里就列举一个单例的模板，如图3.82所示。

图3.82　配置单例模板

生成的代码如图3.83所示。

图3.83　生成单例模板

开发者可以在平时的工作中慢慢积累这些模板，不断提高开发效率。