Win7下Doxygen配置与使用

1. 下载与安装

1.1 下载

Doxygen官方安装程序及其手册下载地址，目前使用版本为1.8.8。

安装程序：http://www.stack.nl/~dimitri/doxygen/download.html

图 1-1 Doxygen安装程序下载界面

在线帮助：http://www.stack.nl/~dimitri/doxygen/manual

图 1-2 Doxygen帮助文档下载界面

GraphViz Doxygen官方安装下载地址及其在线帮助地址，目前使用版本为2.38。

安装程序：http://www.graphviz.org/pub/graphviz/stable/windows/

图 1-3 GraphViz安装程序下载界面

在线帮助：http://www.graphviz.org/Documentation.php

图 1-4 GraphViz在线帮助界面

1.2 安装

以上两个安装程序可以任意安装，但是一定要记住Graphviz的安装路径，Doxygen的设置中要使用此路径以生成调用关系图。

2. Doxygen配置与使用

2.1 基础配置

Doxygen的配置向导可以完成项目路径、工作模式、输出文档、图片工具四个方面的简要配置。

在图2-1中展示了项目路径配置的相关内容：其一，可以设置项目的名称、概述、版本号和项目标志；其二，可以设置源代码所在路径，递归扫描指是否将子文件夹加入源码搜索路径；其三，可以设置代码文档的输出路径，html、rtf等不同格式的代码文档以相应的文件夹存储在此路径之下。

图 2-1 项目配置

在图2-2所示的工作模式配置中，可以设定代码文档中的内容，即包括所有实体还是仅包括标记的实体。除此之外，还要手动选择Doxygen的运行时优化方案，这里选择了针对C语言和PHP的优化选项。

图 2-2 工作模式配置

在图2-3中，选择了输出HTML和RTF格式的代码文档，其中还可以设置HTML代码文档的输出内容，包括纯HTML文档、左侧带有导航树的HTML文档以及CHM文件支持，还可以更改HTML文档的配色方案。

图 2-3 输出代码文档设置

在图2-4所示的界面中，可以自由设置输出文档中是否含有图片、使用Doxygen内置图片工具生成图片、使用GraphViz生成图片三种方式。

图 2-4 图片工具设置

2.2 高级配置

高级配置是对基础配置的进一步细化，以形成不同风格的注释文档。由于涉及参数较多，本文并未给出所有参数的说明，这里仅介绍重要的参数，未尽部分还请读者自行阅读窗口左侧靠下的参数说明（详见图 25左侧红色矩形框所标识的区域）。

图2-5～图2-7完成了项目的详细配置，请注意输出语言一定要选择Chinese，一定要勾选图2-6中的JAVADOC_AUTOBRIEF选项和图2-7中的MARKDOWN_SUPPORT、AUTOLINK_SUPPORT选项，依次表示支持JavaDoc风格注释、Markdown标记方法、注释实体自动链接三种功能。