什么是Doxygen

一 写在前面

当你对外的输出为头文件包及库文件时，撰写头文件的说明文档也是不小的工作量：文件、接口、接口参数的注释说明等等。当接口发生变化，不仅要更新注释，还需要更新说明文档，比较繁琐，同时也很容易出错。而Doxygen工具可以帮助从源文件中生成漂亮的html或其他格式的参考文档，只需要你的注释遵循一定的格式规范即可，方便快捷。

二 什么是Doxygen

Generate documentation from source code

Doxygen is the de facto standard tool for generating documentation from annotated C++ sources, but it also supports other popular programming languages such as C, Objective-C, C#, PHP, Java, Python, IDL (Corba, Microsoft, and UNO/OpenOffice flavors), Fortran, VHDL, Tcl, and to some extent D.

Doxygen can help you in three ways:

1. It can generate an on-line documentation browser (in HTML) and/or an off-line reference manual (in ) from a set of documented source files. There is also support for generating output in RTF (MS-Word), PostScript, hyperlinked PDF, compressed HTML, and Unix man pages. The documentation is extracted directly from the sources, which makes it much easier to keep the documentation consistent with the source code.
2. You can configure doxygen to extract the code structure from undocumented source files. This is very useful to quickly find your way in large source distributions. Doxygen can also visualize the relations between the various elements by means of include dependency graphs, inheritance diagrams, and collaboration diagrams, which are all generated automatically.
3. You can also use doxygen for creating normal documentation (as I did for the doxygen user manual and web-site).

Doxygen is developed under Mac OS X and Linux, but is set-up to be highly portable. As a result, it runs on most other Unix flavors as well. Furthermore, executables for Windows are available.

 译：

从源代码生成文档

Doxygen是用于从带注释的C ++源生成文档的事实上的标准工具，但它也支持其他流行的编程语言，如C，Objective-C，C＃，PHP，Java，Python，IDL（Corba，Microsoft和UNO / OpenOffice风格） ），Fortran，VHDL，Tcl，以及部分支持D语言。

Doxygen三类作用：

1 它能从一组带注释的源文件中生成在线文档浏览器（in HTML）和/或离线参考手册（in latex）.同时也支持生成RTF (MS-Word), PostScript, hyperlinked PDF, compressed HTML, and Unix手册等输出文档。文档直接从源文件中提取，所以更容易使文档与源代码保持一致。

2 你可以配置doxygen从未归档的源文件中提取代码结构。这对于在大型源代码分布中快速找到方法非常有用。Doxygen还可以通过包括依赖图，继承图和协作图来可视化各种元素之间的关系，这些都是自动生成的。

3 你也可以使用doxygen创建文档（就像我为doxygen用户手册和网站所做的那样）。Doxygen是在Mac OS X 和 Linux 下开发的，但高度可移植。因此，它也可以在大多数其他Unix版本上运行。此外，还提供Windows的可执行文件。

此外，Doxygen授予GNU通用公共许可证条款的许可。

三 参考

Dexygen官网