一个好的程序员,离不开代码的注释。在我们写代码的时候一定要养成为代码添加注释的好习惯。
以下就是为代码设置注释模板的方法。
类的注释模板1. 类的注释模板设置过程如下。
Settings-->File and Code Templates-->Includes-->File Header.
你可以在注释里写入自己想要的模块。比如 :文件描述、作者信息、开发时间、版本号。
在这里你还可以引用一些变量。这写变量是Android Studio可以自动生成的。$(USER)、
$(DATE)、$(TIME)等等系统和工程项目的信息变量。我这里用了一个$(DATE)创建文件的时间。
现在我们测试一下我们新建的类的模板注释。
新建一个Test类,建好之后就会是如下。我们可以添加自己的描述文件就可以了。
/**
*文件描述:.
*作者:Created by xingerchuang on 2016/8/1.
*版本号:4.1.0 .
*/
public classTest {
}
2.Methond方法的快捷注释
我们的代码需要封装成一个个的方法。此时就需要为我们的方法添加注释。去描述我们的方法是实现什么样的功能。方法参数及返回值的的解释。
我们在封装好我们的方法之后。现在方法的上一行输入"/**",然后点击回车键,就会自动生成方法的注释模板,我们再去添加方法的详细信息即可。我们在Test类中添加一个add方法。
效果如下
/**
*文件描述:.
*作者:Created by xingerchuang on 2016/8/1.
*版本号:4.1.0 .
*/
public classTest {
/**
*
*计算两个数的和
*@parama : 加数
*@paramb :被加数
*@return:a和b之和
*/
private intadd(inta,intb){
returna + b;
}
}
3.File and Code Templates的其它的一些设置。
在我们创建文件的Activity、布局文件、资源文件、Service、Fragment等文件的时候我们可以
创建自己的文件模板。
我们在这儿以Activity为例,如果我们希望我们的每个创建的Activity都希望有onDestroy().
Settings-->File and Code Templates-->Other-->Activity.
在右侧的代码框中加入我们想要的模板Activity即可。在我们创建Activity的时候就会带有onDestory()方法。
在File and Code Templates里我们还可以设置一些其他的快递开发的模板。可以自己尝试一下
网友评论