cocoa开发使用Doxygen开发

大名鼎鼎的Doxygen，大家一定听说过，其实网络上也有很多关于该软件的文章。这边文章是一个简单的介绍，比较初级，有经验的牛人可以略过。

在开发代码的过程当中，经常遇到的一个问题就是事后希望能有一个类似与msdn的帮助系统，来将自己开发和实现的内容以帮助文档的方式提供，方便自己日后的学习和查找。

在使用Doxygen时，本人比较喜欢使用GUI界面，因此在doxgen的网站下载了mac环境下的GUI版本，这样测试使用起来比较容易。

界面其实很简单，那么下载地址为：

http://www.doxygen.nl/download.html#latestsrc

关键点说明：

1、step1、的路径一定要有，需要填写程序的路径。

2、wizard当中，有project，project需要命名，还需要提供原路径，和目的路径。mode，一定要选择all entriesa否则会.m文件不被导入

3、expert，这个tab，实际上是高级选项，在这里常用的功能是，第一输出语言。OPTIMIZE_OUTPUT_JAVA 实际上是指帮助文档的输出格式问题。也就是说如果选择c优化，那么输出的描述是接头体，如果选择的是java优化，那么输出的描述为类。

4、expert-》build，这个里边的EXTRACT开头的，是指提取文件，需要全部勾选，以保证.h  .m文件当中提到的函数及函数注释都可以被导出。

其他选项，笔者认为默认即可。

5、要想使用doxygen输出类，函数，变量等信息，需要使用特定的注释格式。

我常用的格式为：

/**

* (空格，必须有空格才可以)函数或者是类的具体描述

*/

如果是变量，那么采用右边描述

int me ； /**< 计数用 */