doxygen使用简介（1）

一、简介

Doxygen是一款制作代码文档的工具，可以自动生成HTML，LATEX，PDF，CHM等多种文档，可以为C++, C, Java, IDL (Corba and Microsoft flavors) PHP和C#生成文档。

文档直接由源码生成，这使得文档和代码轻松保持一致性。

除了自动生成函数接口外，还可以将不同元素之间、文件之间和函数之间的关系使用图形自动生成表达出来，包括依赖图，继承图、collaboration图、文件包含图、函数调用图等。

1.1 输出格式

Doxygen的输出格式主要有HTML、LATEX、RTF等：

1. Doxygen在输出HTML文档时，可以自动准备用于制作CHM的项目文件（.hhp）、目录文件（.hhc）和索引文件（.hhk）。用HTML Help Workshop中的CHM编译器（hhc.exe）编译后生成CHM文件。

2. Doxygen在输出LATEX文档的同时准备了转换到pdf格式的makefile。只要系统安装了合适的TEX工具，就可以从LATEX文档生成pdf文档。

3. Doxygen输出的RTF格式，已经针对Word作了优化，可以较好地转换到Word文档。

1.2 软件下载

1. Doxygen的最新版本，可以从http://www.stack.nl/~dimitri/doxygen/download.html#latestsrc下载。

2. Graphviz是一个图形可视化软件。Doxygen使用Graphviz生成各种图形，例如类的继承关系图、合作图，头文件包含关系图等。可以从http://www.graphviz.org/Download..php下载Graphviz的最新版本。Doxygen使用了Graphviz的布局引擎dot，所以在文档中将其称作dot。