希望官方能够重视小程序文档的建设,补全小程序开发文档?
发布于 7 年前 作者 yuangang 10300 次浏览 来自 官方Issues

在日常开发中,避免不了频繁查小程序文档,发现有部分api的属性说明不够清晰或者缺失的情况,

例如: wx.request (https://image.wxopen.club/content_fd3eb7f6-4f0e-11ea-be82-001a7dda7111.png

这个api总共有三个回调函数(successfail, complete),但是文档只对 success 回调函数的参数做出了说明, 对 fail complete 回调的参数无任何说明文档,需要开发者实际操作才知道。

(需要的是回调函数的参数说明),如下:

还比如我之前提出的问题:https://image.wxopen.club/content_fdc874c0-4f0e-11ea-b8e9-001a7dda7111.png,也是文档不全导致开发者无法确定参数返回

文档api或者组件使用说明不清晰不止有上面两个例子,大量普遍的出现在文档中,希望官方能查阅一遍文档,对改补全的参数说明进行补充。

希望官方能够重视小程序文档的建设,希望小程序发展越来越好!

10 回复

这个问题提的专业,经常在fail里面摸不着头脑,然后只能在代码里面上报日志,通过分析日志,再对代码做进一步的判断逻辑~

老三, 大哥帮你顶起来.  文档还是越详细越好, 省的大家都来问

赞同 赞同  每次让开发者去实验,这样不好,有的时候有bug。工具端和真机调试的回调结果还不一样,就会让开发者感到很懵。

三爷,小弟前来膜拜

讲个实际的事情

公司来了实习生,在做小程序的之前,和他千万不要看小程序文档。只有查Api的时候才让他查。

本来好好的,但是有一段时间太忙,没有和他对接。他自己不信邪偷偷去看文档,结果现在脑子全乱了…

他说

  1. 为什么文档写的看不懂,例如wxs写touch事件这个

  2. 为什么api的使用逻辑和自己想的差很多,例如明明写success,以为是成功返回数据,没想到居然是成功调用接口,给我连续打了3个黑人问号

  3. 搜索根本没用,什么也找不到,例如想找获取用户收货信息,搜索框搜索address,完全没有出现

  4. 文档的结构看不懂,每次都重新到处翻

  5. api文档内容太简陋,看完还是不知道怎么用

  6. ...

看vue他用了2天就大致理解会用,结果栽在小程序上了,我遗憾的和他,「没事,我也是这么过来的」

用 typescript 一定程度上可以缓解这问题。不过完整的文档还是必须的

回到顶部