Doxygen使用

doxygen 是一个代码文档生成器，不过功能上还算不错，目前对中文支持也是很好。

1. 首先从http://www.stack.nl/~dimitri/doxygen/ 下载一份最新的源程序，如果是源码包，那么用tar 打开./configure->make ->make install,那么就安装好了，如果是debian用户，现在源里面已经有，可以直接apt安装

2. 安装好后可以先看看他的文档，有比较详细的说明，一般linux用户在/usr/share/doc/doxygen 下面，里面还有一个example，这个比较不多，可以看多很的例子。

3. doxygen 使用也是非常的简单，首先 doxygen -g file(file 为配置文件，如果没有指定 那么它会自动给你生成一个 Doxyfile) .

4. 之后就是对配置文件的修改了，具体的修改可以看它的Doc，这里说几个比较重要的

PROJECT_NAME       项目名称                                            RECURSIVE =YES 设置是否递归
PROJECT_NUMBER      项目版本                                      EXCLUDE   =dir pattern 排除的目录
OUTPUT_DIRECTORY =dir    输出的目录                              INLINE_SOURCES =yes 会显示源码
OUTPUT_LANGUAGE=      输出的语言 目前支持很多 中文也支持
EXTRACT_ALL =        YES 的话将包括的文件都分析
INPUT     =dir           出入的目录
FILE_PATTERNS    =*.c *.h *.cpp .... 分析的文件后缀

还有其他一些，可以看文档

5. 代码的注释，以及一些命令，一般和javadoc 相似,

@author @param @date @file @sa 等等

6. 写好后运行 doxygen -s file 就可以了

7. doxygen可以生成各种格式的文档 除了 html 还有 man latex rtf ， 而且也支持数学公式的生成，以及图片的生成 如类关系图

8. 总之doxygen一个不错的开源doc生成器，今后我将陆续写些使用tip