- Cocos2D-x权威指南
- 满硕泉
- 374字
- 2024-10-30 01:10:21
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所示的界面。
![](https://epubservercos.yuewen.com/8BC93E/3731101304104001/epubprivate/OEBPS/Images/Figure-0035-17422.jpg?sign=1739516599-M4YFg26yX0iRMRg3829IbTK5umI1ZTh6-0-ba67a4e4e3c6ca97399c8ec1907dccdd)
图2-42 Doxygen运行界面
使用File→Open打开Cocos2D-x目录下的doxygen目录下的doxygen.cocos2d-x文件,界面如图2-43所示。
![](https://epubservercos.yuewen.com/8BC93E/3731101304104001/epubprivate/OEBPS/Images/Figure-0036-17437.jpg?sign=1739516599-QvqPmNNatTXnPCcD5pL9AH8taz1fvLpG-0-c1580170ee338e6ffcaf59dae6bf1c57)
图2-43 打开doxygen.cocos2d-x文件后的界面
打开配置文件后出现了Cocos2D-x版本配置信息,单击“Run”选项卡,单击“Run doxygen”按钮,运行生成文档,完成后如图2-44所示。
![](https://epubservercos.yuewen.com/8BC93E/3731101304104001/epubprivate/OEBPS/Images/Figure-0036-17449.jpg?sign=1739516599-BNpiV6eiIlx7p0RelaPu53BO1aLx1Myb-0-15c721c900bd3f62b1cec0e7f5aa6cd1)
图2-44 生成文档
打开Cocos2D-x目录下的doxygen\html目录下的index.html文件,如图2-45所示,可以使用Cocos2D-x文档了。
![](https://epubservercos.yuewen.com/8BC93E/3731101304104001/epubprivate/OEBPS/Images/Figure-0037-17464.jpg?sign=1739516599-kP4PNDL3a1oKH7gt9uJY98SItPXQZaJB-0-99eb3c8ff57da87def73b77b4e7acb2c)
图2-45 Cocos2D-x文档