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

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

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

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


image.png

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

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

So...

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

image.png

至于,具体如何设置,参考些图:

image.png

步骤

    1. 打开android studio设置面板(Ctrl + Alt + S)
    1. 输入搜索: file and code templates
  • 3.选中 Includes下面的 File Header
    1. 填入模板,如下:
/**
 * @author gmf (可以写固定的名称或者使用计算机用户名  ${USER})
 * @description 
 * @date ${DATE}.
 */

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

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

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 202,905评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,140评论 2 379
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 149,791评论 0 335
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,483评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,476评论 5 364
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,516评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,905评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,560评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,778评论 1 296
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,557评论 2 319
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,635评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,338评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,925评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,898评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,142评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,818评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,347评论 2 342

推荐阅读更多精彩内容