Android Studio技巧 之 自动生成类描述

在IT行业中，项目的开发过程，往往是需要多个人一起合作开发，或者是去维护他人的旧代码，可是这样就会导致每次去查看别人编写的类，并且需要了解清楚类的作用时，这样是很耗时间的；当然，如果上一个开发人员有时间给你留下一份开发文档或者源码说明文档，这样很省时间，不过这个是理想状态啊，目前在国内，特别是小公司，一个项目的开发时间，已经是被严重的压缩，需求的实现可能都不够时间，就更加别想，别人会给你留下开发文档或者源码说明文档了。

所以，开发文档什么的，咱们可能是没时间写了，不过，我们可以使用另外的一种模式来替代啊；

就是，在开发过程中，我们每新建一个类，可以在类的头部上或者方法的，添加一些简单的说明，描述当前类的作用，如：

image.png

这样简单的描述使得，不管是以后自己回来看此类，或者是别人接受维护你的代码时都能快速的了解此类的作用。

但是作为程序猿，我们就是要能偷懒就要偷懒的啊，每次建一个类，都需要这样描述，我也觉得烦躁啊。

So...

其实，类的头文件（类描述），我们可以使用开发工具 Android Studio来给我们自动生成一个头部文件模板：

image.png

至于，具体如何设置，参考些图：

image.png

步骤

• 1. 打开android studio设置面板（Ctrl + Alt + S）
• 2. 输入搜索： file and code templates
• 3.选中 Includes下面的 File Header
• 4. 填入模板，如下：

/**
 * @author gmf （可以写固定的名称或者使用计算机用户名  ${USER}）
 * @description 
 * @date ${DATE}.
 */

至此，就可以设置，每次新建一个类，都会自动生成固定的模块，再由我们自己添加几句简单的描述即可。

有工具用，程序猿就该发挥工具的最大作用。一个简简单单的设置，满足我们的需求。