Cocos2d-x 之自己生成API文档

最新推荐文章于 2023-05-29 14:33:43 发布

ltree98

最新推荐文章于 2023-05-29 14:33:43 发布

阅读量2k

点赞数 1

分类专栏： cocos2d-x 文章标签： cocos2d-x doxygen api文档

本文链接：https://blog.csdn.net/lttree/article/details/50278825

版权

本文介绍了API文档的重要性，特别是在Cocos2d-x开发中的作用。文章详细讲解了Doxygen工具，这是一个开源的文档系统，支持多种编程语言。通过Doxygen可以从源代码中提取注释生成文档。最后，作者演示了如何在Cocos2d-x项目中使用Doxygen配置文件快速生成离线API文档。

摘要由CSDN通过智能技术生成

本篇文章大纲：

什么是API文档
什么是doxygen
如何用doxygen生成API文档

1.什么是API文档

API - Application Programming Interface，应用程序接口。
我们在进行程序开发的时候，并不需要知道每个类都有什么函数，引擎已经做好了什么接口供我们调用，而是当你需要用到什么功能，会想先去看看引擎是否已经提供了相应的接口。
最简单的方式，肯定是去类里面看啊，但是，这样找起来相对比较麻烦，于是，就出现了这个API文档，它就像目录一样提供：函数名，返回值，形参列表及功能描述。
然后，如果需要知道这个函数怎么实现，可以再去类里看。
就像一个字典一样，你根据拼音查找这个字，具体意思，再去后面页数查。
cocos2d-x的官网中可以找到最新版本的API文档，可惜在下载的包中是没有文档的，但是，cocos的代码注释非常完整，我们完全可以用一些工具从源程序中提取注释信息并生成文档。
这样，API文档还可以离线查找。