Android Studio添加代码头注释使用总结

前言：

当我们创建一个文件时，一般文件的头部都会生成一定的注释信息，但有时这些注释信息过于简单，并不能满足我们自己的需求，

这时就需要我们来进行一个定制了

效果图：

/** * * 版权：XXX公司 版权所有 * * 作者：will smith * * 版本：1.0 * * 创建日期：2016/9/8 * * 描述： * * 修订历史： * */ 

步骤一：设置模板

File ----> Settings ----->  Editor  ----->  Live Templates  ----->  选中“other”  ------>  点击右侧的 “+”  ------>  选择“Live Tempelate”

如下所示：

其中，

Abbreviation表示你想要设置的快捷键，这样通过输入快捷键，你就可以调出这个模板

Description表示设置这个模板的描述信息，这个描述信息随意，并不影响我们最终的模板样式

Template text表示我们要设置的模板的样式，例如我填写的模板样式如下：

/** * * 版权：XXX公司 版权所有 * * 作者：will smith * * 版本：1.0 * * 创建日期：$DATE$ * * 描述： * * 修订历史： * */

$DATA$ 这是手动定义的一个变量，如何定义？

在Template text中输入$变量名成$，这样就是一个变量，变量名称是自己自定义的，

只有这样定义之后，右侧的Edit variables这个按钮才会生效，此时我们再点击 Edit variables这个按钮，

去编辑我们定义的变量就可以，例如，我定义的$DATA$变量编辑如下：

最后记得点击Apply  ------>  OK

步骤二：运用模板

直接在你的文件头部输入你刚才定义的快捷键，例如我刚设置的快捷键为：cfh

然后回车，就可以看到代码头注释就已经生成了，如下：

/** * * 版权：XXX公司 版权所有 * * 作者：will smith * * 版本：1.0 * * 创建日期：2016/9/8 * * 描述： * * 修订历史： * */ public class Main2Activity extends AppCompatActivity {    @Override    protected void onCreate(Bundle savedInstanceState) {        super.onCreate(savedInstanceState);        setContentView(R.layout.activity_main2);    }}

注：

在这里我没有用File and Code Tempelates  ------>  include  ------->  File Header，主要是因为若不是我们自己手动创建的类，而是系统自动帮我们创建的类的时候，

此时，代码头注释信息就没有，所以干脆使用了Live Tempelates，然后用快捷键来予以创建

参考：

让代码印上自己的标签