收集用户读 api 范例 文档 时遇到的问题

我也遇到了这个问题

链接失效问题
比如说吧我想要查看vec2的具体属性


然后里边木有x,y这两个明显属于他的属性,然后我找到ValueType

里边依然没有我要的东西,但是我看到了里边有一个“定义于:url” 的链接

然后就是这个了,不光是这个 基本我找到的所有这种链接全部失效了。

我还有个疑惑例如:


明明moveBy传入是3个参数,可为什么实际使用时两个参数
cc.moveBy(持续时间,vec2对象);
这个语法我无法理解 是重载吗?cc.moveBy拥有多个重载用于接收不同的参数?
还是说vec2这个数参数会被解析成x,y坐标 然后自动填充了?

啊 我是第一次接触cocos所有有些地方不是很理解。

额,那个好像不是链接哦,而是你引擎目录下的地址

不是重载,只能说是模拟重载,这涉及到js语法方面的知识(arguments),函数的实参可以是动态的,也就是说如果你形参是两个的话,实参可以是任意个,然后在函数内部判断参数的个数,不同个数的参数执行不同的操作

比如你函数的形参定义是两个,实际只传入了一个参数,第二个参数就是undefined,这个时候就可以判断第二个参数的值,根据第二个参数的值来决定执行什么操作

如果形参是两个,实参是三个或者四个或者更多,可以通过arguments对象获得,

建议你去了解一下js的arguments

moveBy函数的原理是这样的,判断最后一个参数是不是undefined,如果是,代表只有两个参数,那么就把第二个参数当成一个对象,从这个对象里获取x和y的值,如果第三个参数不是undefined,就把第二个参数当成x的值,第三个参数当成y的值

所以你用两个参数也可以,三个参数也可以

那个,能提个小建议吗,关于API页面左侧这一栏
有时候想查一些东西的时候

点击之后,左边这一栏就切回初始页面去了

这样的话,有时候打开了函数页面却发现函数并不是我想要的(特别是我这种新手),或者说想要看一下其他的相关函数的时候,我就不得不重新在搜索框里重新输入一遍
或者换句话说,用户对自己的搜索结果的页面应该比这个初始页面跟感兴趣些吧…

发现个问题

文档里的内容

这里说加载进来的单个资源如果需要释放,可以调用cc.loader.releaseRes,releaseRes只能传入一个和loadRes相同的路径

我测试过后发现,我通过cc.loader.loadResAll加载的资源,我这边loadResAll是传入一个目录(“texture”),加载目录里的所有资源,然后我释放的时候是这样的cc.loader.releaseRes(“texture/1”)

我不知道是不是我钻牛角尖,还是我没有理解到,不知道loadRes和loadResAll在这里是否相同,但是我批量加载的资源也可以通过cc.loader.releaseRes来释放,并且参数和loadResAll的不一样(多了个资源名称应该算是不一样还是算一样?)

这里我不知道是因为没有loadResAll加载资源后释放的文档,还是loadRes的文档没有考虑到loadResAll

所以来发表下意见

如果是没有loadResAll加载资源后释放的文档,建议大神加一下

如果是loadRes的文档没有考虑到loadResAll,建议大神改一下

如果我的看法有错误,建议大神当我放了个屁:joy:

奥 原来如此谢谢呀

感谢感谢 话说用js做页面这么久 头一次听说js还有这样的语法, 看来我的先好好看看语法了

你说的是啥?形参和实参不同吗?这个去了解arguments就行了,如果你说的是通过判断参数的不同来执行不同的代码,这个是自定义的,不是js语法

嗯,好的这个会反馈,如果好修复会尽快完善

这会看一下,如果是 bug 会修复的,修复后在给你答复。:+1:

好的,谢谢,我觉得算不上bug,就是loadResAll加载的资源也可以通过releaseRes来释放,因为loadResAll的路径参数一般是文件夹,但是用releaseRes释放的时候可以定位到具体文件,所以我觉得可能是没有写相关文档,加上就可以了

还有哦,可不可以批量释放资源呢?比如批量加载的资源要释放?

嗯,可能会 添加 releaseResAll 来进行释放 loadResAll 加载的资源

好的,谢谢:watermelon:

多谢反馈,我们计划在 1.4 加入 releaseResDir,并且将 loadResAll 更名为 loadResDir

才10分钟 已经很快了

作为一个Creator的新手,这个API确实有点难懂,首先API左侧列表没有分类简单介绍,对于新手来讲,不知道在什么时候去哪些分类里去找需要调用的那些API,最关键的是花大量的时间找到API后,下面只有简单一段文字,没有示例难以理解(不知道有多少小伙伴是学习Creator 5~6 遍还是啃不下来,原因都是在这里!)

举例说明吧,类似下图这个样子

新手以为直接调用cc.moveTo()就可以,根本就不会再次去调用runAction(),也不知道去调用,也不知道去什么地方找这个问题,一直一直在不断的修改代码,最后还是调试失败!

建议官方完善API文档

API名字
API功能简单介绍
API参数 类型 必填 参数简单介绍
API参数 类型 必填 参数简单介绍
API参数 类型 可空 参数简单介绍

API调用示例

API调用效果

如果是这样一份的API文档,相信市面上会增加很多Creator的游戏,吐槽完毕!