本节书摘来异步社区《Cocos2D-X游戏开发技术精解》一书中的第1章，第1.6节，作者： 刘剑卓 责编： 陈冀康，更多章节内容可以访问云栖社区“异步社区”公众号查看。
1.6 技术文档
Cocos2D-X游戏开发技术精解
前面的章节内容，曾介绍了两个包含引擎的技术文档的地方，细心的读者一定会留有印象。在引擎的官方网站，提供了在线版本的API指南。以防读者忘记了，下面列出的网址就是访问路径。
http://www.cocos2d-x.org/reference/native-cpp/index.html
在引擎的下载包中也提供了技术文档。不过，技术文档的内容其实包含在代码中，读者需要一个工具才能生成网页版本。这个工具就是Doxygen。它是一个C++、C、Java、Objective-C、Python、IDL（CORBA和Microsoft flavors）、Fortran、VHDL、PHP、C#和D语言的文档生成器。它可以运行在大多数类UNIX系统，以及Mac OS X操作系统和Microsoft Windows。它是一个编写软件参考文档的工具。因为此工具是从源文件提取注解来生成文档，所以开发者需要将注解直接写在代码中。这种方式可以很好地保持与源代码的同步。
下面以Windows操作系统为例，讲解技术文档生成的方法。读者需要从网络下载Doxygen应用软件。读者不要搞错了平台版本，而且如果不想通过命令行来生成文档的话，记得下载包含GUI的版本。在其官方网站可以找到最新版本。网络地址如下所示。
http://www.doxygen.org/
安装的过程和其他电脑软件类似，直接点击下一步就可以了。然后运行软件，读者就会看到如图1-6所示的画面。
在菜单界面中选择文件，然后打开引擎目录中cocos2d-2.0-x-2.0.4documentdoxygen.config文件。
此文件就是引擎中提供的技术文档生成文件。有了它，读者就可以省去配置的过程，直接点击“Run Doxygen”按钮，很快就能够获得网页版本的API指南了，在引擎document目录将会生成一堆文件。读者可以直接点击“Show HTML output”或者通过浏览器访问其中的index.html，就会看到如图1-7所示的界面。
在技术文档中，开发者可以查到引擎中每一个类以及函数。这就是引擎使用指南宝典。不过，为了考虑国际化，技术文档是英文版本。正所谓“代码无国界”，对于开发者来说代码片段还是可以看懂的。在文档中，将引擎的功能按照模块划分方便查询。开发者也可以按照字母顺序或者直接搜索，来查询类以及函数。文档中还提供了基本的类和函数的解释。有一点读者需要明确，文档的所有内容都来自于源代码。所以在源代码中，我们也能够看到同样的内容，只不过技术文档更直观和系统一些。同时，在网页中展示的类的继承关系以及引擎组成更容易理解。
说明：
生成的文档，可以在各个平台自由访问。
此技术文档将会成为读者经常需要查看的手册。在以后的游戏开发中，如果有关于引擎中类以及函数不清楚的地方，就可以来这里寻找答案了。此技术文档只能作为一个类和函数的指南，其中并没有讲解类和函数具体的用法，这也是本书存在的价值。如何正确、有效地使用引擎制作游戏，才是开发者的主要能力。
除此之外，在今后的开发中如果遇到了技术难题，这是指那些具体情况下出现的问题，读者可以选择在网站的讨论区寻求帮助。答案的一种可能是已经有人遇到了同样的问题并提供了解决方案。另一种可能是会有高手协助解决问题。如果有朝一日，读者也成为了一个有丰富经验的游戏开发者，去讨论区参与解决技术难题，也是颇有乐趣的一件事。对于英文不好的开发者，也可以去Cocos2D-X的中文社区，地址如下。
http://cn.cocos2d-x.org/
