2015061508 - 注释分析(1)
来源:互联网 发布:星尘浏览器知乎 编辑:程序博客网 时间:2024/06/07 10:01
下面截图是绝大部分接口中类似的一部分
稍好一点的接口如下:
说明接口用途,只要参数名称和实际意义相同.但是依旧有问题
比如查询获取剩余每日额度,如果额度为0,那么返回值是null还是new BananaQuota()呢.对于方法调用者来说,需要知道方法做什么,方法需要什么,需要注意什么,返回值代表什么.如果方法定义时候无法提供,那么调用者就需要了解方法的实现细节,而对于调用者而言根本就是浪费时间.
如果方法调用者需要知道的内容无法知晓,那么就需要了解具体的实现细节.对于接手开发或者后期维护人员,除了知道用途,根据参数名称查看参数意义,成功的返回值.特殊实现思路需要自己花费时间阅读,这些都是最初开发者最熟悉的,只完成功能实现,却没有为后来人准备.
接口作用,参数,以及参数特殊说明,方法的特殊实现思路,特殊情况的返回值介绍,对阅读接口而言足够.
0 0
- 2015061508 - 注释分析(1)
- 2015061509 - 注释分析(2)
- EventBus源码注释分析
- 分析注释 sequence_input_layer.py
- AR引擎vuforia源码分析、中文注释(1)
- squid命中率分析参数注释
- tcp ack 处理注释分析
- tcp sock struct 注释分析
- tcp cubic 算法分析注释
- GBDT源码分析和注释
- xv6分析--mkfs源代码注释
- 北大天网搜索引擎TSE分析及完全注释[1]寻找搜索引擎入口
- 北大天网搜索引擎TSE分析及完全注释[1]寻找搜索引擎入口
- KiFastCallEntry from wrk 注释、简单分析
- libnids分析(9)---nids.h注释
- Even Odds代码与分析,有注释
- Uboot 的u-boot.lds注释分析
- Jquery-Ajax实例分析加注释
- 2015061507 - 注释说明
- 微软云虚拟机外网访问
- Python - VS Complier
- C#数据绑定
- java笔记15 多线程2(线程通信、Lock)
- 2015061508 - 注释分析(1)
- 开始写第一个android软件(聊天软件)
- Mysql修改字符集
- 2015061509 - 注释分析(2)
- 2015年下半年信息系统项目管理师课程安排表
- Notifications 通知
- 6月15日所得所感
- 深入学习横竖屏切换时候Activity的生命周期
- 2015061510 - 枚举