Doxygen学习笔记（0）- 利用Doxygen快速生成帮助文档

Doxygen是一种开源跨平台的，以类似JavaDoc风格描述的文档系统。

使用Doxygen，可以

（1）快速生成说明文档；

（2）协助阅读分析代码；

（3）规范代码。

Doxygen学习笔记系列介绍如何上手Doxygen，适用于新手。

系列包含

Doxygen学习笔记（0）- 利用Doxygen快速生成帮助文档；

Doxygen学习笔记（1）- 安装和配置 Doxygen ；

Doxygen学习笔记（2）- 使用Doxygen生成文档；

Doxygen学习笔记（3）- Doxygen注释规范；

1.简介（来自百度百科）

Doxygen是一种开源跨平台的，以类似JavaDoc风格描述的文档系统，完全支持C、C++、Java、Objective-C和IDL语言，部分支持PHP、C#。注释的语法与Qt-Doc、KDoc和JavaDoc兼容。

Doxygen可以从一套归档源文件开始，生成HTML格式的在线类浏览器，或离线的LATEX、RTF参考手册。对于未归档的源文件，也可以通过配置Doxygen来提取代码结构。

或者借助自动生成的包含依赖图（includedependency graphs）、继承图（inheritance diagram）以及协作图（collaborationdiagram）来可视化文档之间的关系。

Doxygen生成的帮助文档的格式可以是CHM、RTF、PostScript、PDF、HTML和Unixman page等。

2.使用步骤（来自百度百科）

由于只是工具的使用，这里不介绍它的原理，直接从使用步骤开始。Doxygen的使用步骤非常简单。主要可以分为：

（1）第一次使用需要安装doxygen的程序

（2）生成doxygen配置文件

（3）编码时，按照某种格式编写注释

（4）生成对应文档

doxygen的安装非常简单， linux下可以直接下载安装包运行即可，下载源代码编译安装也是比较通用的编译安装命令。请参考其安装文档完成安装。

Doxygen在生成文档时可以定义项目属性以及文档生成过程中的很多选项，使用下面命令能够产生一个缺省的配置文件：

doxygen -g [配置文件名]

可以根据项目的具体需求修改配置文件中对应的项，具体的修改过程在下面介绍。修改过的配置文件可以作为以后项目的模板。

运行下面的命令，相应的文档就会产生在指定的目录中。

doxygen [配置文件名]

需要注意的是doxygen并不处理所有的注释，doxygen重点关注与程序结构有关的注释，比如：文件、类、结构、函数、变量、宏等注释，而忽略函数内变量、代码等的注释。

3.Doxygen使用意义

（1）快速生成说明文档；

（2）协助阅读分析代码；

（3）规范代码。

参考资料