收藏
回答

希望官方能够重视小程序文档的建设,补全小程序开发文档?

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

例如: wx.request (https://developers.weixin.qq.com/miniprogram/dev/api/network/request/wx.request.html

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

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


还比如我之前提出的问题:https://developers.weixin.qq.com/community/develop/doc/0000607a21cfc86d1a690d0e351000,也是文档不全导致开发者无法确定参数返回

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

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

最后一次编辑于  11-21
回答关注问题邀请回答
收藏

24 个回答

  • 连胜
    连胜
    11-21

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

    11-21
    赞同 26
    回复 8
    • 连胜
      连胜
      11-21
      有时候每个机型返回的错误还不一样,或者是不同的基础库版本返回错误也不一样,比如deny和denied就是出现在不同的基础库版本中,不踩坑就不知道。
      11-21
      2
      回复
    • 三爷
      三爷
      11-21
      对呀,文档中很多参数的说明不够清晰,导致开发者需要实际操作尝试,这样造成有时候会有遗漏的参数或者字段出现,导致线上bug
      11-21
      回复
    • console.log()
      console.log()
      11-21
      对开发进度影响很大,所以完整的文档是必要的,对于新手有案例就更好啦
      11-21
      回复
    • 维他柠檬茶呀
      维他柠檬茶呀
      11-21
      占个位,官方文档有很多坑,希望可以多多补全.
      11-21
      回复
    • showdown
      showdown
      11-21
      跪求更新完整
      11-21
      回复
    查看更多(3)
  • 社区技术运营专员-娇华
    社区技术运营专员-娇华
    11-21

    https://developers.weixin.qq.com/community/develop/doc/00008443130560da55386506856800

    需求已在开发计划中。

    11-21
    赞同 2
    回复 5
  • 陈式坚
    陈式坚
    11-29

    讲个实际的事情

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

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

    他说

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

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

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

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

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

    6. ...

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

    11-29
    赞同 2
    回复 2
    • 三爷
      三爷
      星期二 16:20
      未改版前的文档要详细很多,这个新版的精简了
      星期二 16:20
      回复
    • 三爷
      三爷
      星期二 16:21
      以前的有很多使用示例,现在的很多示例没了
      星期二 16:21
      回复
  • 龙
    11-21

    顶一下~

    11-21
    赞同 2
    回复
  • G-STEPS街舞工作室
    G-STEPS街舞工作室
    11-21

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

    11-21
    赞同 1
    回复 2
    • 三爷
      三爷
      11-21
      你无法知道fali返回参数,所以你怎么定义接口呢?还是得根据文档参数说明,进行类型定义
      11-21
      回复
    • G-STEPS街舞工作室
      G-STEPS街舞工作室
      11-21回复三爷
      官方有维护一个types https://github.com/wechat-miniprogram/api-typings
      11-21
      回复
  • 等我想好再说
    等我想好再说
    11-29

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

    11-29
    赞同
    回复
  • 放学别跑
    放学别跑
    11-21

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

    11-21
    赞同
    回复
  • 浅忆青空
    浅忆青空
    11-21

    三爷,小弟前来膜拜

    11-21
    赞同
    回复
  • 一点一滴
    一点一滴
    11-21

    11-21
    赞同
    回复
  • 管清🔥🌞  🌞
    管清🔥🌞 🌞
    11-21
    赞同~
    11-21
    赞同
    回复

正在加载...

问题标签