在使用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
2.安装好Doxygen后，打开软件进行参数设置
3.点击Run doxygen开始生成文档
4.生成完毕后，打开文档的生成位置（刚才设置的是cocos2d文件夹），多了一个html文件夹，
5.打开html文件夹中的index.html文件，这个是文档的入口
6.这里可以查看所有的类
7.我们来看看CCSprite类
8.有继承结构图
9.有方法列表
10.点击某个方法，还可以看到方法的详细说明
到这里为止，html格式的文档就搞定了
将cocos2d的文档集成到Xcode中
说明：cocos2d版本是1.0.1，Xcode版本是4.5
前提：先安装上面的Doxygen软件到Applications(应用程序)目录下
1.打开cocos2d中的doxygen.config文件，设置成输出中文文档（其实只是部分关键字为中文，这个步骤可以省略）
2.双击打开cocos2d-ios.xcodeproj
3.设置cocos2d-documentation为target
4.编译这个target
提示：点击编译后，会自动执行一些脚本去生成文档，请耐心等待。编译过程中会产生很多错误和警告，这个不影响文档的生成，可以忽略
5.看到Build succeed就代表文档生成完毕，这时候请
完全退出Xcode
后再重新打开Xcode，接着查看文档
6.可以看到cocos2d的文档已经集成到Xcode中了
7.其实本质是将文档打包成一个.docset文件，然后生成到：/Users/
apple
/Library/Developer/Shaerd/Documentation/DocSets文件夹中(我的用户名叫apple)，Xcode会去这里加载所有的文档，不过只会在打开Xcode时加载一次，这也是要完全重启Xcode才能查看新生成的cocos2d文档的原因
两种处理cocos2d文档的方式都介绍完了，个人更推荐采取第2种方式：集成到Xcode中，这也是开发中最常见的方式
创建
Cocos2D-iPhone
的帮助文档
Cocos2D
中的
API
不属于苹果官方提供
,
因此
,
在默认情况下
,
Xcode
的帮助文档中无法查到
Cocos2D
中的
API
帮助信息
。
为了方便学习和使用
Cocos2D
中所提供的
API
,
可以访问
Cocos2D
官方提供的在线文档
(
http://www.cocos2d-iphone.org/api-ref/2.0.0/
)。
除此之外
,
还有一种方法可以非常方便地获取最新的
API
文档
,
那就是使用
Dash
工具
。
Dash
是一款集
API
文档浏览和代码片断管理于一体的工具
,
它支
持
iOS
、
Android
、
Cocos2D
、
Unity
等
20
多种框架或语言的文档浏览功能
。
最重要的是
,
这些文档会随时得到更新
,
只需要升级相应的更新包即可
。
虽然这款软件不是免费的
,
想要使用其完整的功能必须购买才行
。
不过
,
其免费版本并不妨碍我们把它当作
文档查询工具来使用
。
要使用
Dash
,
首先必须下载
。
下载过程其实非常简单
,
只需要打开
App Store
,
在搜索里面输入
Dash
关键字
,
在查询的结果中找到下图
所示的程序
Icon
。
单击下载安装即可
。
安装完
Dash
之后
,
需要安装
Cocos2D
的文档集
。
首先
,
打开
Dash
的
“
应用程序偏好设置
”
,
并切换到
Downloads
标签
,
如图
1-12
所示
。
安装好
Cocos2D
的文档包之后我们再打开
Dash
,
这时在左上角的搜索框内输入
CCSprite
,
此时会得到如图
1-13
所示输出
(
免费版本字体显示红色
)。
下图下载
Cocos2D
文档包
(
此图是安装好之后的状态
)
使用
Dash
搜索
CCSprite
关键字的结果
