Cocos2d-x 中文文档迎来大幅改版升级!

为了解决之前文档网站的各种使用体验感不尽人意的问题,在下个版本正式上线之前,我们特别使用了 Gitbook 作为文档的生成工具,并增加了许多新特性。新版文档经过引擎团队反复的测试和修改,目前已经在网站上线,欢迎大家积极测试并反馈意见。


新旧文档的区别,具体表现在以下几点:


1、新文档内容完善和升华


用户手册基于 Cocos2d-x v3.16 最新版本进行改版,借由四个部分从 0 到 1 向开发者重点介绍了 Cocos2d-x:


新手入门部分,可以了解到 Cocos2d-x 引擎是什么、如何学习引擎、如何参与引擎开发,以及引擎中一些基本的概念;

基本功能部分,着重介绍引擎中一些基础同时核心的组件如何使用,包括精灵、动作、场景;

进阶内容部分,是对引擎更近一步的阐述,包含如何进行一些高级控制、显示一些特殊效果;

环境与工具部分,包含详细的开发环境搭建教程,以及一些引擎可利用的工具,比如使用 cocos 命令行。


以下是手册的章节索引,帮助快速定位。


2、中英文文档相辅相成相得益彰


本次改版,我们解决了之前旧文档中、英文独立分离的尴尬场面,将中、英文文档合并到同个页面,只要轻点切换键,就能实现在中文和英文之间自由切换的舒适布局,让开发者畅享一键切换的快捷体验。而且英文文档和中文文档实时同步更新,真正做到国内外一致,完善文档部署。




3、Gitbook 作生成工具,界面简洁舒适


此次新文档我们特别使用了 Gitbook 作为文档的生成工具。Gitbook 的优点,相信开发者已经能够在日常生活工作中体验到。它不仅可以免费创建私有库,保密性较高;而且类似于 Github,有版本控制,就像电子书版的Github。另外 Gitbook Editor 是一个很好用的 Markdown 编辑器,有很多贴心的快捷键让你发掘,比如cmd+shift+d,如果你用习惯 Atom、Sublime、Textmate 之类的编辑器,会很喜欢这些特性。还有最最重要的优势是一次编写,多处使用!对于维护 API 接口,随心所欲分发接口文档事半功倍。


4、增加反馈按钮,点击跳转 Github


我们在每个页面增加了反馈问题的悬浮按钮,当遇到文档内容错误、缺失,或表述不明的情况,大家都可以很方便的点击按钮来提交 Github issue。



框选有问题的文本并点击反馈按钮后,就会自动打开文档网站的 Github issue 页面。


在 issue 信息中已经自动包括了刚才页面的链接和高亮的文本,接下来只要在后面补充你的问题然后点击绿色的 「Submit new issue」按钮即可成功提交反馈了!


欢迎大家在阅读文档时随时把问题和建议通过这种方式发给我们,我们会持续对文档进行补充和优化!


5、全文搜索和功能关键字搜索


新版文档全面强化了搜索功能,在左侧搜索栏输入任何你想了解的话题,会立刻在全部文档正文和标题中对搜索内容进行匹配并返回结果。点击任何搜索结果进入页面后,搜索的关键词还会保持高亮状态。



对于比较难理解的关键词,只要点击链接前往在线源码查看内部逻辑,就能够对我们使用时遇到的问题提供很大的帮助。 如果阅读源码后发现引擎实现有问题,请顺便在 Github 页面为我们提出 issue 或 pull request!


若有遗漏的地方,欢迎补充和反馈!


戳原文,新文档体验!
相关文章
相关标签/搜索