Doxygen + Graphviz 安装(windows 10系统) 教程

一、准备工作

1、windows 10系统

2、下载doxygen，可以自己从官网下载，如果下不下来可以从我百度云盘下，我下载的是doxygen-1.8.10-setup版本

下载地址：https://pan.baidu.com/s/1BBpc1YSshyHdlDY5lSs8EA

3、graphviz下载，我下载的是graphviz-2.37.20140115版本，

下载地址：https://pan.baidu.com/s/1BfuCMcBQgR0F8MVIH0HI5g

二、安装

首先安装Graphviz ，再安装doxygen，安装没什么，一路next就ok了

1、安装Grapgviz

下载后双击安装，跟着提示安装即可，安装后可能在桌面没有graphviz的快捷方式，不过不用担心，在我们的开始菜单里面可以找到。开始->所有程序->Grapgviz->gvedit.exe。

安装在任意喜欢的位置。但是需要把安装目录的graphviz/bin加入环境变量PATH里，我这里只写了相对路径。

打开cmd，输入：dot –help，如果弹出以下信息，就是安装成功：

下面我们将使用graphviz手册上的一个小例子进行演示。代码如下：

  digraph G{        size = "5, 5";//图片大小      main[shape=box];/*形状*/        main->parse;      parse->execute;        main->init[style = dotted];//虚线        main->cleanup;      edge[color = green]; // 连接线的颜色        execute->{make_string; printf}//连接两个        init->make_string;      main->printf[style=bold, label="100 times"];//线的 label        make_string[label = "make anstring"]// n, 这个node的label，注意和上一行的区别        node[shape = box, style = filled, color = ".7.3 1.0"];//一个node的属性        execute->compare;  }

运行结果如下：

2、安装doxygen，一路next就行（略）

三、使用

1、配置doxgen

这是最核心的，你可以设置你要提取注释的源文件，生成的文档格式，工程名称，文档的Logo等信息，这些配置是可以存储起来的，当你的源代码更新后，重新再运行这个配置文件，就可以重新生成一个新的文档。

在安装后，进入到其安装目录下的bin文件夹，它里面有两个文件：doxygen.exe和doxywizard.exe，我们先运行doxywizard.exe来进行配置，从而生成配置文件（如果是第一次运行）。

图1，Doxygen配置主界面。

1，Doxygen工作目录，就是用来存储配置文件的目录。

2，递归搜索目录需要选上。

图2，选择输出文档格式

图3，生成类图

图4，选择文档的编码格式。

说明：编码格式，UTF-8是首选。如果需要显示中文则选择GB2313。

图5，设置提取的范围。

图6，设置源码的格式。

图7，设置生成CHM文件属性。

图8，配置完成后，点击"Run doxygen"来运行配置，最后，点击File->Save存储配置文件，下次就不用再配置了。