doxygen 1.11.0 使用详解（一）—— 介绍

介绍

doxygen 是从注释的 C++ 源码中产生文档的事实上的标准工具，但它同时也支持其他很多广受欢迎的语言，比如 C、Objective-C、C#、PHP、Java、Python、IDL (Corba、Microsoft 和 UNO/OpenOffice)、Fortran 和一定程度的 D 语言。 doxygen 也支持硬件描述语言 VHDL。

doxygen 的用途主要有三个：

1. 从注解的代码源文件中产生 HTML 格式的在线文档和 LATEX 格式的离线文档。也可以产生 RTF(MS-Word)，PostScript，hyperlinked PDF，compressed HTML 和 Unix man pages 等格式的输出文档。文档是直接从源文件中产生的，因此这使得文档与源码保持一致变得十分容易。
2. 对 doxygen 进行配置，从未注释的源文件里提取出代码结构等信息。doxygen 还可以通过自动生成的头文件包含依赖图、继承图、协作图等，对不同的代码元素之间的关系进行可视化。
3. 通过 doxygen 写普通的文档。

doxygen 是在 Mac OS X 和 Linux 下开发的，但它是高度可移植的。它不仅可以运行在其他 Unix 变种上，还可以在 Windows 上运行。

License

doxygen 是在 GNU General Public License 下发布的。