使用 Doxygen 从源代码生成 UML 类图

Posted 2022-10-24 阿基米东

Doxygen 简介

Doxygen 是一个编写软件参考文档的工具，也是从带注释的 C++ 源代码生成文档的事实上的标准工具。这意味着该文档是直接写在源代码中的，因此比较容易保持更新。Doxygen 支持交叉引用，因此文档的读者可以很容易地引用实际的源代码。

虽然 Doxygen 常用于 C++ 项目，但它同时也支持其他流行的编程语言，例如 C、Objective-C、C#、php、Java、Python、IDL（接口描述语言，如 Corba、Microsoft 和 UNO/OpenOffice 风格）、Fortran 等等。在某种程度上，Doxygen 也支持 D 语言、VHDL 硬件描述语言。

Doxygen 的发布遵守 GNU 通用公共许可证（GPL 2.0），是一个优秀的自由软件。你可以在 https://doxygen.nl 下载最新的 Doxygen 源代码和预编译二进制文件。

Doxygen 安装

在 Ubuntu 系统中，执行下面命令安装 doxygen 和 graphviz 软件包。

sudo apt install graphviz    # 用于生成代码关系图 
sudo apt install doxygen

使用示例

进入工程目录，执行下面命令生成配置文件

doxygen -g Doxygen.config

修改配置文件 Doxygen.config

EXTRACT_ALL            = YES
HAVE_DOT               = YES
UML_LOOK               = YES
RECURSIVE              = YES 

根据代码生成文档

doxygen Doxygen.config

在工程目录下可以看到生成的 html 和 latex 目录，使用网络浏览器（例如 Chrome）打开 html 目录中的 index.html 文件，可以看到如下类似文档页面。

找到代码中的某一个类，可以看到其 UML类图，如下所示。

---

你学会了吗？