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中了

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

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

时间: 2024-10-18 02:10:18

cocos2d文档的使用的相关文章

LuaIde 文档导航页

VsCode使用基础 LuaIde 配置项 FAQ 视频教程地址 调试代码下载 cocos2d调试文档 Ulua&ToLua调试文档 SLua调试文档 xLua调试文档

cocos2d-x 3.0 使用Sax解析xml文档(解决中文显示问题)

今天是个好日子,心想的事儿都能成,明天是个好日子,打开了家门儿迎春风... 恩,听着歌写文档生活就是这么享受. 今天以前的邻居大神突然在qq上赞了我一下,这让我异常激动啊..这还要从前前前几天说起,那会无意间看到cocos微信上的一个实话实说活动,反正就是参加了可以抽奖这样子啦,没错,我就是本着那官方T恤去的,本着分子越大分母越大抽奖几率越大的原则,然后就连着发了一番感慨,而且还都是比较罗嗦,没想到隔天cocos君竟然给我回复了,中奖了有木有,cocos2dx的官方T恤,哈哈..然后就是以前的大

1.2.3 创建Cocos2D-iPhone的帮助文档

http://book.51cto.com/art/201303/383957.htm <Cocos2D权威指南>第1章开始前的准备工作,本章我们将介绍什么是Cocos2D以及有关Cocos2D的一些重要基础知识,包括如何下载与安装Cocos2D-iPhone的模板.如何安装Cocos2D-iPhone的帮助文档.最后,通过一个有趣的实例介绍如何创建一个最基本的HelloCocos2D项目,并带领读者对这个项目进行深入学习.本节为大家介绍创建Cocos2D-iPhone的帮助文档. AD:WO

Dash——程序员的的好帮手:API文档浏览器+代码片段管理工具

作为一名死coder,每天最常见的动作就是查看各种API文档,你一定也有过同时打开N个窗口(HTML.PDF.CHM),不停的在编辑器与文档之间切换的感受吧?怎么说呢,其实我很讨厌这种枯燥无味的动作,那么如何才能提高效率,减少无用功呢?下面就给大家介绍一款非常好用的Mac小工具:Dash,相比这个英文名,我跟喜欢叫它“叮当猫”,嘿嘿. 点我直达AppStore介绍页面 功能简介 官方用一句话就概括了它的用途:Dash是一个API文档浏览器( API Documentation Browser),

通过beego快速创建一个Restful风格API项目及API文档自动化(转)

通过beego快速创建一个Restful风格API项目及API文档自动化 本文演示如何快速(一分钟内,不写一行代码)的根据数据库及表创建一个Restful风格的API项目,及提供便于在线测试API的界面. 一.创建数据库及数据表(MySQL) #db--jeedev -- ---------------------------- -- Table structure for `app` -- ---------------------------- DROP TABLE IF EXISTS `a

[转贴]xcode帮助文档

突然间得到了一台MAC ,这时候不学OC 更待何时学呀?马上找了IOS开发的书和网上的帖子看,最近在开源力量那里看了TINYFOOL的入门讲座,讲的都很虚,可能时间不够吧,也没看到什么例子呀,什么的,很蜻蜓点水,点到即止,BUT ANYWAY,在开源IOS 入门讲座完了就突然得到了一台MAC,不知道是不是上天的安排,还是学一下OC吧,毕竟水果的支持时间是有限的,一般我估计3年后水果不再支持这款MAC,到时想学也不够条件了,我们这种吊丝真的经常被生活所迫.在网上找到一个文章教人看XOCDE的帮助文

标准文档流

标准流指的是在不使用其他的与排列和定位相关的特殊CSS规则时,各种元素的排列规则.HTML文档中的元素可以分为两大类:行内元素和块级元素.       1.行内元素不占据单独的空间,依附于块级元素,行内元素没有自己的区域.它同样是DOM树中的一个节点,在这一点上行内元素和块级元素是没有区别的.       2.块级元素总是以块的形式表现出来,并且跟同级的兄弟块依次竖直排列,左右自动伸展,直到包含它的元素的边界,在水平方向不能并排.盒子在标准流中的定位原则margin控制的是盒子与盒子之间的距离,

使用Apache POI导出Excel小结--导出XLS格式文档

使用Apache POI导出Excel小结 关于使用Apache POI导出Excel我大概会分三篇文章去写 使用Apache POI导出Excel小结--导出XLS格式文档 使用Apache POI导出Excel小结--导出XLSX格式文档 使用Apache POI导出Excel--大数量导出 导出XLS格式文档 做企业应用项目难免会有数据导出到Excel的需求,最近在使用其,并对导出Excel封装成工具类开放出来供大家参考.关于Apache POI Excel基本的概念与操作我在这里就不啰嗦

Atitit 项目文档规范化与必备文档与推荐文档列表

===========比较重要的必备文档========== 项目组名单通讯录( 包括项目组,客户沟通人等 需求文档 原型ui文档 开发计划表 项目源码与架构文档以及新结构文档 设计文档 (一般概要即可,重点模块单独详细设计) 数据库文档 注意事项 =========对开发比较重要的文档 Svn源码服务器账号密码 测试数据库账号密码信息 数据库sql脚本文件. 开发环境搭建文档 项目技术规范文档.(项目模式和产品模式有很多不同,需要单独分离) ======其他 测试说明文档 测试服务器部署账号信