《Cocos2D-x权威指南》——2.4 使用Doxygen工具生成Cocos2D-x文档

2.4　使用Doxygen工具生成Cocos2D-x文档

Doxygen是一种开源跨平台的工具，其功能是从程序源代码中抽取类、方法、成员的注释，形成一个和源代码配套的API（Application Programming Interface，应用程序编程接口）帮助文档。Doxygen工具完全支持C、C++、Java、Objective-C等语言，部分支持PHP、C#。
Doxygen可以根据代码中的注释，按照规则生成相应的文档。Cocos2D-x的代码就依照了它的规则，并且提供了doxygen.cocos2d-x文件。这是Cocos2D-x代码的 Doxygen 配置文档，可以通过这个文件来生成Cocos2D-x文档。
首先下载Doxygen，下载地址为http://www.doxygen.nl/download.html#latestsrc。根据系统选择要下载的版本，建议下载安装版。下载完成后运行程序，出现如图2-42所示的界面。

使用File→Open打开Cocos2D-x目录下的doxygen目录下的doxygen.cocos2d-x文件，界面如图2-43所示。

打开配置文件后出现了Cocos2D-x版本配置信息，单击“Run”选项卡，单击“Run doxygen”按钮，运行生成文档，完成后如图2-44所示。

打开Cocos2D-x目录下的doxygenhtml目录下的index.html文件，如图2-45所示，可以使用Cocos2D-x文档了。