C++ 使用Doxygen 生产UML类图

下载安装

 

sudo apt install graphviz
sudo apt install doxygen

----------或者-----------------

sudo brew install doxygen
sudo brew install doxygen

使用方法

进入工程目录,生成config文件

doxygen -g Doxygen.config

编辑config文件,建议修改以下内容

HAVE_DOT = YES
EXTRACT_ALL = YES
EXTRACT_PRIVATE = YES
EXTRACT_STATIC = YES
CALL_GRAPH = YES

根据config文件生成文档,这一步如果项目较大时间会比较久。

doxygen Doxygen.config

之后会在工程目录下生成一个html文件夹和 latex文件夹。可以直接打开html文件下的index.htm浏览查看整个工程下的UML类图。具体效果可参考下图

参考链接:

使用 Doxygen 从源代码生成 UML 类图_11757891的技术博客_51CTO博客

Mac下使用Doxygen和Graphviz生成函数调用关系图 - 知乎

  • 0
    点赞
  • 5
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Doxygen 是一款用于生成 C++ 代码文档的工具。它可以根据程序源代码中特定的注释格式自动生成文档,包括类、函数、变量等的说明和使用方法,使得代码文档更加规范和易于维护。 以下是使用 Doxygen 生成 C++ 代码文档的步骤: 1. 安装 Doxygen 工具。可以从 Doxygen 官网上下载安装包,并按照相应的操作系统进行安装。 2. 在 C++ 源代码中添加特定的注释格式,以便 Doxygen 工具能够识别并生成文档。例如: ``` /** * @brief 该函数用于计算两个整数的和 * * @param a 第一个整数 * @param b 第二个整数 * @return 两个整数的和 */ int add(int a, int b) { return a + b; } ``` 3. 配置 Doxygen 工具。可以通过在 Doxygen 安装目录下找到并运行 doxygen 命令来打开配置向导,或者手动编辑配置文件。需要设置源代码目录、输出目录、文档格式等配置项。 4. 运行 Doxygen 工具。可以通过在命令行中执行 doxygen 命令来生成文档,或者通过 Doxygen 工具提供的 GUI 界面来操作。生成的文档会保存在指定的输出目录中。 5. 查看生成的文档。使用浏览器打开生成的文档首页,即可浏览和查看代码文档。 以上是使用 Doxygen 生成 C++ 代码文档的基本步骤。需要注意的是,注释格式必须符合 Doxygen 的要求,否则可能无法生成正确的文档。同时,注释中应该包含足够的信息,以便其他人能够理解和使用代码。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值