doxygen全套工具——包括说明文档

使用 Doxygen 根据注释生成帮助文档

一． 什么是 Doxygen?

Doxygen 是一个程序的文件产生工具，可将程序中的特定批注转换成为说明文件。通常我们

在写程序时，或多或少都会写上批注，但是对于其它人而言，要直接探索程序里的批注，与打

捞铁达尼号同样的辛苦。大部分有用的批注都是属于针对函式，类别等等的说明。所以，如果

能依据程序本身的结构，将批注经过处理重新整理成为一个纯粹的参考手册，对于后面利用您

的程序代码的人而言将会减少许多的负担。不过，反过来说，整理文件的工作对于您来说，就

是沉重的负担。

http://jaist.dl.sourceforge.net/project/doxygen/rel-1.8.4/doxygen-1.8.4-setup.exe

graphviz-2.30.1.msi(不是必需)如果需要使用更强大的功能比如类继承体系图等则需要安装

此软件配置使用

http://www.graphviz.org/pub/graphviz/stable/windows/graphviz-2.30.1.msi

四． 配置

Step 1:是 Doxygen 的工作目录，请指定一个已存在的非中文的文件夹

主界面如下图：

Step 2:具体配置

Wizard 选项卡

 Project

Diagrams

(Use built-in class diagram generator)将使用内置的生成功能生成每个类的类图，只有一

个类是不为生成的。