今天终于忍不住 要对 api 文档吐槽吐槽了~~

1 文档为了写而写 略官方:我很奇怪把代码实现的贴上去是做什么用?api文档我关心怎么用,如何实现我可以去代码呀。
例如:
session.bind(uid,cb)
Bind current session with the user id. It would push the uid to frontend server and bind uid to the global session.

此方法只能在前段服务器调用。这是我研究了2个晚上,参考例子程序推测出来的。
最要命的是 我在非前段服务器调用,并不提示我错误,而提示我一个 Converting circular structure to JSON 错误。 中间各种蛋碎的分析排查就不说了...

2 文档缺乏关键点说明:在使用pomelo的过程中,多次遇到诡异的问题,文档基本没有着重说明,

例如:
// app configuration
app.configure('production|development', 'connector', function(){
app.set('connectorConfig',
{
connector : pomelo.connectors.hybridconnector,
heartbeat : 3,
useDict : true,
useProtobuf : true
});
});

这个配置如果是必须的 强调一下好不好呢...
中文例子的引导里 放在了 其他配置 章节中

> 对于websocket.io版本需要在app.js中对connector进行配置,具体配置如下:

这个潜台词难道不是 我要是不关心 scoket 是版本用哪个库,我就不用管它了。结果就悲剧了呀。
各种连接不上呀(程序还工作的,端口监听状态 ,telnet 可用,但是就是pomelo连接不上,回想起来太心碎了呀)。 弄个默认配置好不好的呀?

...2个晚上的时间发现各种蛋碎的问题 只是 session.bind() 不能在 非前段服务器调用 ,非常的蛋碎呀...

另外官方能不能出个 官方qq群呀,把我们这些 比较活用的用户加进去,大家沟通方便些呀。
本来这个问题就应该是一句话问你们一下就ok了的事情,我蛋碎的研究了2个晚上呀...

标签:无
xdxttt 在 2013-5-19 22:03发布
xdxttt 在 2013-5-19 22:05重新编辑 分享到 weibo
15 回复
#1 c38funuk 2013-5-20 09:31 回复

是的,我现在觉得POMELO这个框架,学习成本太高了。很多东西写的都不清楚。BAIDU和GOOGLE也查不出来。很多都需要自己去试错学习,这个时间太浪费了。

#2 halfblood 2013-5-20 09:45 回复

一个新生事务的出现,必然要经过很多此折腾,经历过时间的沉淀,方可成为精华!
目前这个框架出来的时间还不是很久,baidu和google搜不出来和合情合理,如果你灌水多了,以后baidu和google搜出来的答案就是你今天的灌水,呵呵!
1.session.bind()确实只能在前端服务器里面使用,后端服务器没有报错,是因为bind函数确实是javascript里面的函数。
2.pomelo本身就有默认的配置,默认支持客户端行为,根据客户端的协议(socket.io/websocket等)动态调整的。
3.qq群有啊292495320,不过不是官方的,但是也很活跃。不过还是建议你在论坛或者issues里面提问题,这样其他人也能看到。
期待共同进步!

#3 py8765 2013-5-20 09:57 回复

事物。。

#4 {2} xiecc 2013-5-20 10:09 回复

嗯,谢谢反馈,由于框架中涉及的内容较多,文档会有些不周到的地方, 我们会补充一下。
异常情况的提示信息也只能逐步完善。

xdxttt 2013-5-20 16:35 回复

目前异常提示比较蛋碎啊。求加强啊...

实在是因为自己 js苦手...不然一定热心提交代码...现在是能看懂就不错了...:(

awhlmycn 2014-8-15 14:49 回复

能不能搞个 中文版啊!中国人 老是崇外

#5 minghe 2013-6-18 17:02 回复

唉。对阿。API只有源码,不告诉怎么用!

#6 ttkktt 2013-6-19 10:32 回复

我也是来吐槽pomelo的文档的,目前的文档真心是有等于无。。。

#7 jiangzhuo 2013-6-19 14:31 回复

我觉得嘛 看官方api文档的说明英语还怪费劲,还不如直接看代码懂得清楚。
我猜是不是写api文档的怕自己描述不清楚,所以直接把代码贴上了 (捂嘴偷笑中)

#8 lyn0032 2014-9-26 11:03 回复

特地注册完过来顶LZ,文档太差劲啦,让我这个新手完全没办法入门。

#9 lyn0032 2014-9-26 11:04 回复

真心想转去研究萤火虫了。。。

#10 qqirod 2014-9-26 18:31 回复

的确缺乏文档,还好这个框架和我以前用C++/lua写的框架差不多,但这个框架功能更完善,所以才转用这个框架。昨晚研究了一下这个框架的源代码,自己加了热更新的功能。

#11 titan 2014-9-27 09:58 回复

个人感觉:
1. 入门文档其实差不多够了,可以自己搭建一个简单的服务器,但缺点是不够系统,需要自己到处找,建议在github的wiki中建一个索引页面,分章节展示,而不是各种page很散乱。
2. 进阶文档确实不足,开发过程中的各种坑、各种配置的详细解释等,导致开发正式项目时处处踩雷。相信如果这方面完善后momelo的使用者将指数增长~!

#12 yushan 2015-4-29 16:19 回复

那个API文档是八百年前的了,连API都懒得更新,还搞什么开源,更不用提API的质量了

#13 jieseo 2015-4-30 14:54 回复

相当蛋痛文档。。。还英文

#14 sjfkai 2015-5-6 15:01 回复

好吧。看到喷的这么猛,我也就放心了……

#15 {1} qqirod 2015-5-7 14:59 回复

就说说那个配置吧,
app.set('connectorConfig',
{
connector : pomelo.connectors.hybridconnector,
heartbeat : 3,
useDict : true,
useProtobuf : true
});
});

这些配置选项都有什么作用,该怎么用.而且除了这4个选项外,还有没有别的配置,完全找不到文档说明.pomelo可能没时间没精力建个群一一回答网友的问题,因此文档才要更清晰.外国人开发的东西和中国人开发的东西有一个很大的区别,就是外国人的就算一个很简单的功能,都会尽可能给详细的文档,遇到任何情况你只要查文档就可以了.中国人开发的东西,开发好后,只有开发的人懂用.如果开发的人一段时间不碰他开发的东西,下次他要弄明白自己的程序,还要自己重新看代码.

jiangjkd 2015-12-30 09:51 回复

确定很蛋疼,感觉网易已经是放弃pomelo的,好久没维护,也没回复开发者的问题了

回到顶部