cocos2D(二)---- cocos2D文档的使用,----cocos2d 生成HTML文档 将cocos2d的文档集成到Xcode中

  次阅读 来源:互联网(转载协议) 2015-09-28 15:29 我要评论(0)

cocos2D(二)---- cocos2D文档的使用,----cocos2d

在使用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中了

本站部分文章来源于网络以及网友投稿,本站只负责对文章进行整理、排版、编辑,是出于传递更多信息之目的,并不意味着赞同其观点或证实其内容的真实性。如果您有什么意见或建议,请联系QQ28-1688-302!

人工智能实验室
相关文章相关文章
  • Oculus公布原型机,大幅度提升可视角,能实现140°的视场水平

    Oculus公布原型机,大幅度提升可视角,能实现140°的视场水平

  • 2018深圳国际人工智能展览会 2018 shenzhen International Artif

    2018深圳国际人工智能展览会 2018 shenzhen International Artif

  • teamLab创始人猪子寿之: 抛去衣食住行,我还剩下什么?

    teamLab创始人猪子寿之: 抛去衣食住行,我还剩下什么?

  • Michael I. Jordan带你解读百万奖金ATEC蚂蚁人工智能大赛

    Michael I. Jordan带你解读百万奖金ATEC蚂蚁人工智能大赛

网友点评网友点评
阅读推荐阅读推荐

据外媒报道,STEER打造了首款完全自动驾驶停车技术,旨在使常规车辆转变为无人驾驶车辆。STEER的首款技术应用是4级自动驾驶及网络安全停车...

近日,美国软性机器抓手制造商 Soft Robotics 宣布,获得 2000 万美元的融资,本轮投资者包括 Scale Venture Partners,Calibrate Ventures...

据外媒报道,加州车管局发布了《2017自动驾驶脱离报告(California Autonomous Vehicle Disengagement Reports)》,其中谈及了脱离的具体...

用人机语音交互,来解决智能家居适老的问题;通过家庭门禁与安防套件、空气净化套件、可燃气体与有害气体监控套件等相互联动,在不同生活情...