Android代码注释模版

Android代码注释模版

一、注释模版的内容 代码注释生成文档,所以,部分注释内容需要用到html标签排版内容以达到代码美观的目的,常用的

有等,Android studio 在 file菜单中选择settings 搜索File and Code Templates,在右侧菜单中选择不同的代码使用场景并编辑为需要的模版,在生成注释时就可以生成自己想要的注释

二、注释代码脚本编写

生成代码模版时,需要用到默认的生成内容,例如,将@author的默认内容设定为自己的用户名,方法一、直接配置内容 或者配置内容为 USERNAME时间为{DATE} 、YEAR、{ORGANIZATION_NAME}

三、通用注释模版

1.文件(Files)注释标签:

/**

* All rights Reserved, Designed By Android_Robot

* @Title: filename∗@Package{package_name}

* @Description: todo(用一句话描述该文件做什么)∗@author:AndroidRobot∗@date:{date} ${time}

* @version V1.0

*/

2.类型(Types)注释标签(类的注释):

/**

* @ClassName: typename∗@Description:{todo}(这里用一句话描述这个类的作用)

* @author: Android_Robot

* @date: date{time}

*

* ${tags}

*/

3.字段(Fields)注释标签:

/**

* @Fields field:{todo}(用一句话描述这个变量表示什么)

*/

4.构造函数标签:

/**

* @Title: enclosingtype∗@Description:{todo}(这里用一句话描述这个方法的作用)

* @param: ${tags}

* @throws

*/

5.方法(Methods)标签:

/**

* @Title: enclosingmethod∗@Description:{todo}(这里用一句话描述这个方法的作用)

* @param: tags∗@return:{return_type}

* @throws

*/

6.覆盖方法(Overriding Methods)标签:

/**

*

Title: ${enclosing_method}

*

Description:

* tags∗{see_to_overridden}

*/

7.代表方法(Delegate Methods)标签:

/**

* tags∗{see_to_target}

*/

8.getter方法标签:

/**

* @Title: enclosingmethod∗@Description:pleasewriteyourdescription∗@return:{field_type}

*/

9.setter方法标签:

/**

* @Title: enclosingmethod∗@Description:pleasewriteyourdescription∗@return:{field_type}

*/

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

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,577评论 18 139
  • 设置注释模板的入口: Window->Preference->Java->Code Style->Code Tem...
    柒黍阅读 629评论 0 0
  • github排名https://github.com/trending,github搜索:https://gith...
    小米君的demo阅读 4,528评论 2 38
  • 明天你是否会想起 昨天你写的日记 明天你是否还惦记 曾经最爱哭的你 老师们都已想不起 猜不出问题的你 我也是偶然翻...
    人生只有一次请好好珍惜阅读 270评论 0 4
  • Who are you? I'm here! 等你 是我能做的最长久的事 醒来 我笑笑 和往日一样 往周一样 往月...
    MiaLL阅读 314评论 3 1