wildfirechat / im-server

即时通讯(IM)系统
http://docs.wildfirechat.cn
Other
7.78k stars 1.77k forks source link

好代码不提供一个字的注解,其实就是打广告而已, #702

Closed zxyyang closed 1 month ago

zxyyang commented 1 month ago

提issue小提示

为了尽快定位问题,需要提供足够的信息,请按照我们的要求格式来提问。如果您不按照格式提问,我们将无法回复您的问题

操作说明

详细说明操作那个界面,每一步骤都要说得详细,如果是SDK或者api使用问题,需要详细说明调用的那个函数,参数都是什么。

表现现象

描述一下什么现象,比如说函数返回error,errorcode是多少,或者界面上是什么状态,比如发送消息显示发送失败的红点。不要笼统的说功能有问题,不起作用。

预期结果

你认为正确的表现应该是什么样的。

补充条件

是否是必现的,还是偶现的?是否只有在特殊的网络/设备/平台上出现,还是所有的都出现。还有您用的版本是什么时候的,是不是最新版

demo对比结果

请用demo对比测试,demo上是什么状态。

检索已有问题

除了可以检索已有issue外,还可以去野火论坛查找已有问题,论坛地址为 https://bbs.wildfirechat.cn

star 我们

给我们点个star,可以及时接收到我们回复信息,另外也是对我们支持人员辛苦工作的认可,激励我们更好更快地为大家服务。

heavyrain2012 commented 1 month ago

不是不提供注释,实际上是我们所有代码基本上都没有注释,包括我们私有的部分。我们认为好的代码从函数名称和参数名称就能清晰地知道代码的意思,如果写注释会浪费本来就不多的人力,还是跟代码设计造成冗余。

我们更愿意让客户无障碍的使用我们的代码,我们不提供收费的技术支持,也不提供收费的定制开发,收费仅限于文档上收费的内容,不会有其他隐藏的收费项目。我们提供的论坛和issue的技术支持都是免费的,需要占用我们公司有限的人力,我们没有做删除注释提高客户使用难度的动机。

事实上我们有对整个系统有系统的描述,https://github.com/wildfirechat/docs/tree/master/md 这个文档涵盖了我们所有的平台和端,有几百万文字的描述。编译后就是 https://docs.wildfirechat.cn ,这些没有一个是代码生成的,每个文字都是一个字一个字敲出来的

最后还是感觉您对我们项目的关注