如何使用 Doxygen 生成项目文档

最近在看一个现有项目的代码,整个项目几乎没有什么注释。花了一个多月的时间阅读代码,想为它整理出一份文档。很自然我就想到了现在有没有可以自动生成文档的工具。不费功夫便找到了Doxygen。下面就介绍如何使用 Doxygen 生成项目文档。

安装软件

Doxygen 可以从它的官网上下载到,它支持多系统。下载好了之后就可以开始安装。如果想在文档中可以看到方法之间的调用关系和可以生成 .chm 文件,那么还需要安装 Graphviz 和 HTML Help Workshop。

生成文档

软件安装好了之后,启动 Doxygen。在生成文档之前需要进行一些参数设置。
参数配置
设置项目参数。设置项目名、项目版本号、源代码路径和目的路径。
参数配置
选择模式。可以选择提取模式和编程语言。
参数配置
设置输出参数。可以选择输出的格式。
参数配置
设置图。为生成的图设置参数。
后面便是专业级的设置,可以参数截图进行设置,也可以参考网上的资料来设置。
参数配置
参数配置
参数配置
参数配置

参数设置完成后点击 Run doxugen,程序就开始为你生成文档了。
参数配置

程序运行结束后,你可以 OUTPUT_DIRECTORY 目录中看到生成好的文档。
打开 .chm 文件,可以找到函数调用关系图,它用处很大。
函数调用关系图

题外话

当接手一个陌生的项目时,如何快速的熟悉项目结构,流程呢?
用 Doxygen 生成文档之后发现,.chm 中的函数调用关系图能让我事半功倍的熟悉一个项目。没有这些关系图,项目中的执行流程只能够靠阅读代码后分析得到。然而,对于那些没有注释或者注释不够的代码,阅读起来非常困难,要花很多的时间才能熟悉它的流程。

参考

  1. DOXYGEN简明实用教程
  2. 使用doxygen生成chm范例