Cocos2d-x 之 自己生成API文档

本篇文章大纲：

什么是API文档

什么是doxygen

如何用doxygen生成API文档

1.什么是API文档

API - Application Programming Interface，应用程序接口。

我们在进行程序开发的时候，并不需要知道每个类都有什么函数，引擎已经做好了什么接口供我们调用，而是当你需要用到什么功能，会想先去看看引擎是否已经提供了相应的接口。

最简单的方式，肯定是去类里面看啊，但是，这样找起来相对比较麻烦，于是，就出现了这个API文档，它就像目录一样提供：函数名，返回值，形参列表及功能描述。

然后，如果需要知道这个函数怎么实现，可以再去类里看。

就像一个字典一样，你根据拼音查找这个字，具体意思，再去后面页数查。

cocos2d-x的官网中可以找到最新版本的API文档，可惜在下载的包中是没有文档的，但是，cocos的代码注释非常完整，我们完全可以用一些工具从源程序中提取注释信息并生成文档。

这样，API文档还可以离线查找。

2.什么是Doxygen

Doxygen是一种开源跨平台的，以类似JavaDoc风格描述的文档系统，完全支持C、C++、Java、Objective-C和IDL语言，部分支持PHP、C#。注释的语法与Qt-Doc、KDoc和JavaDoc兼容。Doxygen可以从一套归档源文件开始，生成HTML格式的在线类浏览器，或离线的LATEX、RTF参考手册。————（百度百科）

Doxygen 官网：

http://www.doxygen.nl/

在download 选择相应版本下载即可

3.如何用doxygen生成API文档

其实，在cocos2d-x中都做好了配置，

已经属于傻瓜式安装了

打开doxygen.exe，选择file->open->找到cocos2d-x相应版本目录下的docs文件夹下的doxygen.config

然后，一直下一步，最后run即可

输出文档，就在docs文件夹下的html文件夹内，所有相关内容都在里面，找到 index.html 打开，就可以进行相应的使用了。