二、cocos2d文档的使用

时间:2023-02-07 21:13:34

  在使用cocos2d进行游戏开发的过程中,难免要查阅cocos2d的API文档,搞清楚怎么使用某个类或者某个方法。幸运的是,cocos2d的作者已经在源代码里面添加了文档注释,我们只需要使用文档生成工具解析源代码生成文档即可。最常用的文档生成工具是Doxygen

  用Doxygen处理cocos2d文档有2种方式:

第1种方式:安装Doxygen软件,解析cocos2d源代码,生成html格式的静态文档

第2种方式:利用cocos2d自带的Doxygen功能,将文档集成到Xcode中

下面我分别详细说明上述2种方式的实现步骤:


生成HTML文档

1.下载dmg格式的Doxygen软件http://www.stack.nl/~dimitri/doxygen/download.html#latestsrc

二、cocos2d文档的使用

 

2.安装好Doxygen后,打开软件进行参数设置

二、cocos2d文档的使用

 

3.点击Run doxygen开始生成文档

二、cocos2d文档的使用

 

4.生成完毕后,打开文档的生成位置(刚才设置的是cocos2d文件夹),多了一个html文件夹,

二、cocos2d文档的使用

 

5.打开html文件夹中的index.html文件,这个是文档的入口

二、cocos2d文档的使用

 

6.这里可以查看所有的类

二、cocos2d文档的使用

 

7.我们来看看CCSprite类

二、cocos2d文档的使用

 

8.有继承结构图

二、cocos2d文档的使用

 

9.有方法列表

二、cocos2d文档的使用

 

10.点击某个方法,还可以看到方法的详细说明

二、cocos2d文档的使用

到这里为止,html格式的文档就搞定了


将cocos2d的文档集成到Xcode中

说明:cocos2d版本是1.0.1,Xcode版本是4.5

前提:先安装上面的Doxygen软件到Applications(应用程序)目录下

1.打开cocos2d中的doxygen.config文件,设置成输出中文文档(其实只是部分关键字为中文,这个步骤可以省略)

二、cocos2d文档的使用

 

二、cocos2d文档的使用

 

2.双击打开cocos2d-ios.xcodeproj

二、cocos2d文档的使用

 

3.设置cocos2d-documentation为target

二、cocos2d文档的使用

 

4.编译这个target

二、cocos2d文档的使用

提示:点击编译后,会自动执行一些脚本去生成文档,请耐心等待。编译过程中会产生很多错误和警告,这个不影响文档的生成,可以忽略

 

5.看到Build succeed就代表文档生成完毕,这时候请完全退出Xcode后再重新打开Xcode,接着查看文档

二、cocos2d文档的使用

 

6.可以看到cocos2d的文档已经集成到Xcode中了

二、cocos2d文档的使用

 

7.其实本质是将文档打包成一个.docset文件,然后生成到:/Users/apple/Library/Developer/Shaerd/Documentation/DocSets文件夹中(我的用户名叫apple),Xcode会去这里加载所有的文档,不过只会在打开Xcode时加载一次,这也是要完全重启Xcode才能查看新生成的cocos2d文档的原因

二、cocos2d文档的使用

 

两种处理cocos2d文档的方式都介绍完了,个人更推荐采取第2种方式:集成到Xcode中,这也是开发中最常见的方式