Android studio之代码注释

日子不是用来混的
      要想成为一个优秀的编程人员，需要养成好的编程习惯，代码注释就是一个很好的编程习惯，做好代码注释可以让团队其他成员看懂你写的代码，并且自己在回看自己代码的时候，可以松的看懂。
下面来介绍下Android studio增加快捷代码注释的方法：

      1.进入File -> Settings ->Editor ->Live Templates，点击对话框右侧的“+”号，选择Template Group先建一个自己的组，如”customer”：

     

      2.选中customer组，再次点击右侧的“+”号，选择Live Template去增加注释文件：

      3.比如建一个类文件的注释，如下图，在Abbreviation框输入注释名称“file”，在Description框输入该注释的描述“class annotation”，在Template text里面输入注释的内容：

注释内容：

/**     * Copyright (C) 2016 TOMRA GROUP. All rights reserved. *   *  @Package: $package_name$ *  @Description: $todo$ *  @author: David Li *  @date: $date$ $time$ */

其中

$$中间的为变量，需要链接到对应的方法，步骤5会编辑变量。

      4.需要注释类型，点击Define，在Java->Declaration处打勾：

 

      5.编辑变量，注释内容中带$$号的为变量，需要链接到相应的方法：

，

如$file name$对应为fileName()，$package_name$对应currentPackage(),在注释的时候android studio会调用该方法去获取相应的值，编辑完以后点击Apply即可。

      6.在代码中输入file回车既可以输入注释：

以此类推可以增加方法，变量等的注释。