AndroidStudio使用之——两种方式添加类注释模板

时间:2024-03-18 19:38:33

我要给一个类添加注释块,网上通常能看到的方法是:File-> Setting-> File and Code Templates-> Includes ->FileHeader 

然后就是添加注释模板内容,例如:

/**
*        
*  @author zhougang
*  @date  ${DATE} ${TIME}
*
*/


${DATE}  和 ${TIME} 这些事变量,变量的使用就是${ }这种格式,有哪些变量可以用在下面的Desctription栏里已经列出来了。

这种方式是在创建类的时候自动生成注释。


而有一种情况是,这个类可能是之前已经存在的,而且没有注释,我想添加注释,上面的方法就不适用了。

我想要的效果是:在类名上面我输入某个内容或是快捷键,就能生成注释模板。经过研究发现还真有这个方法:

File-> Setting ->Live Templates ->New Live Template(或者先建一个Group,再在里面建Templates) -> Abbrevation里随意填写一个名字->Description可以不写->

下面就是填写模板 内容,例如:

/**
 *
 *   $desc$
 *   @author zhoguang
 *   @date  $date$ $time$
 */

下面就是要注意的重点:  这里的变量$date$ ,$time$ 使用方法跟上面那种不一样。 格式是:$变量名$

这样还没完,还要给变量赋表达式,点击右边的“Edit variables” ,$date$赋值 date()函数,$time$赋值 time()函数,  $desc$赋值空字符串。如下图:

AndroidStudio使用之——两种方式添加类注释模板


最后还有一个要注意的是,要在模板下面点击选择Applicable 的范围 ,我选的所有的java文件里这个模板适用。如上图。