在日常开发中,避免不了频繁查小程序文档,发现有部分api的属性说明不够清晰或者缺失的情况,
例如: wx.request (https://image.wxopen.club/content_fd3eb7f6-4f0e-11ea-be82-001a7dda7111.png)
这个api总共有三个回调函数(success,fail, complete),但是文档只对 success 回调函数的参数做出了说明, 对 fail 和 complete 回调的参数无任何说明文档,需要开发者实际操作才知道。
(需要的是回调函数的参数说明),如下:
还比如我之前提出的问题:https://image.wxopen.club/content_fdc874c0-4f0e-11ea-b8e9-001a7dda7111.png,也是文档不全导致开发者无法确定参数返回
文档api或者组件使用说明不清晰不止有上面两个例子,大量普遍的出现在文档中,希望官方能查阅一遍文档,对改补全的参数说明进行补充。
希望官方能够重视小程序文档的建设,希望小程序发展越来越好!
讲个实际的事情
公司来了实习生,在做小程序的之前,和他千万不要看小程序文档。只有查Api的时候才让他查。
本来好好的,但是有一段时间太忙,没有和他对接。他自己不信邪偷偷去看文档,结果现在脑子全乱了…
他说
为什么文档写的看不懂,例如wxs写touch事件这个
为什么api的使用逻辑和自己想的差很多,例如明明写success,以为是成功返回数据,没想到居然是成功调用接口,给我连续打了3个黑人问号
搜索根本没用,什么也找不到,例如想找获取用户收货信息,搜索框搜索address,完全没有出现
文档的结构看不懂,每次都重新到处翻
api文档内容太简陋,看完还是不知道怎么用
...
看vue他用了2天就大致理解会用,结果栽在小程序上了,我遗憾的和他,「没事,我也是这么过来的」