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}

*/

最后编辑于 :
©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

相关阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 137,268评论 19赞 139
  • 设置注释模板的入口: Window->Preference->Java->Code Style->Code Tem...
    柒黍阅读 815评论 0赞 0
  • 明天你是否会想起 昨天你写的日记 明天你是否还惦记 曾经最爱哭的你 老师们都已想不起 猜不出问题的你 我也是偶然翻...
    人生只有一次请好好珍惜阅读 364评论 0赞 4
  • Who are you? I'm here! 等你 是我能做的最长久的事 醒来 我笑笑 和往日一样 往周一样 往月...
    MiaLL阅读 517评论 3赞 1
  • 今天的带读很有同感的是我老公就是一个喝水先生,结婚最初的几年不论和他说什么,回答我的都是“多喝点水”。很多时候跟水...
    蜂蜜辣椒汁阅读 229评论 0赞 0

友情链接更多精彩内容