111

我一直在寻找一些描述如何使用 doxygen 生成简单类图的材料，但找不到。有人可以帮忙吗？

我需要从一组 C++ 文件中创建如下所示的图表。 替代文字

如果有更好的工具可以更轻松地实现这一目标，请告诉我。

4

6 回答 6

64

嗯，这似乎是一个老问题，但是由于我最近几天一直在搞乱 Doxygen 配置，而我的脑海中仍然充满了当前的信息，让我们试一试 -

我认为以前的答案几乎都有：

缺少的选项是添加COLLABORATION_GRAPH = YESDoxyfile。我假设你可以在 doxywizard GUI 的某个地方做同样的事情（我不使用 doxywizard）。

因此，作为一个更完整的示例，我倾向于使用的与 UML 输出相关的典型“Doxyfile”选项是：

EXTRACT_ALL          = YES
CLASS_DIAGRAMS      = YES
HIDE_UNDOC_RELATIONS = NO
HAVE_DOT             = YES
CLASS_GRAPH          = YES
COLLABORATION_GRAPH  = YES
UML_LOOK             = YES
UML_LIMIT_NUM_FIELDS = 50
TEMPLATE_RELATIONS   = YES
DOT_GRAPH_MAX_NODES  = 100
MAX_DOT_GRAPH_DEPTH  = 0
DOT_TRANSPARENT      = YES

这些设置将生成“继承”（CLASS_GRAPH=YES）和“协作”（COLLABORATION_GRAPH=YES）图。

根据您对 doxygen 输出“部署”的目标，设置DOT_IMAGE_FORMAT = svg也可能有用。使用 svg 输出，图表是“可缩放的”，而不是位图格式（如 .png）的固定分辨率。显然，如果在 IE 以外的浏览器中查看输出，也INTERACTIVE_SVG = YES可以对生成的 svg 图进行“交互式缩放和平移”。前段时间我确实尝试过，svg 输出在视觉上非常吸引人，但当时浏览器对 svg 的支持仍然有点不一致，所以希望这种情况最近可能有所改善。

正如其他评论所提到的，其中一些设置（DOT_GRAPH_MAX_NODES特别是）确实具有潜在的性能影响，因此 YMMV。

我倾向于讨厌“RTFM”风格的答案，因此为这句话道歉，但在这种情况下，Doxygen 文档确实是您的朋友，所以请查看上述设置中的 Doxygen 文档——上次我查看时，您可以在以下位置找到详细信息http://www.doxygen.nl/manual/config.html。

于 2016-07-12T07:46:27.850 回答
57

Doxygen 创建继承图，但我认为它不会创建整个类层次结构。它确实允许您使用 GraphViz 工具。如果您使用 Doxygen GUI 前端工具，您将在Step2: -> Wizard tab -> Diagrams. DOT 关系选项位于专家选项卡下。

于 2011-01-21T06:41:24.887 回答
49

引用这篇文章（它是由 doxygen 的作者自己写的）：

run doxygen -g and change the following options of the generated Doxyfile:

    EXTRACT_ALL            = YES
    HAVE_DOT               = YES
    UML_LOOK               = YES

run doxygen again
于 2013-03-06T13:18:56.997 回答
7

Enterprise Architect 将从导入的源代码构建 UML 图。

于 2014-07-30T16:07:00.180 回答
5

我认为您需要编辑 doxys 文件并将 GENERATE_UML（类似的东西）设置为 true。你需要安装 dot/graphviz。

于 2011-01-21T06:28:31.327 回答
5

投票率最高的 2 个答案是正确的。到今天为止，我唯一需要更改的（从默认设置）是启用使用 dot而不是内置生成器的生成。

一些重要的注意事项：

  • Doxygen 不会生成项目中所有类的实际完整图表。它将为每个层次结构生成一个单独的图像。如果您有多个不相关的类层次结构，您将获得多个图像。
  • 所有这些图表都可以在html/inherits.html或（来自网站导航）类 => 类层次结构 =>“转到文本类层次结构”中找到。
  • 这是一个 C++ 问题，所以让我们谈谈模板。特别是如果你继承自T.
    • Doxygen 将正确地将每个模板实例化视为不同的类型。从不同实例继承的类型将在图上具有不同的父类。
    • 如果类模板foo继承自T并且T模板类型参数具有默认值，则将假定该默认值。如果有一个bar继承自foo<U>where的类型U与默认值不同，bar则将有一个foo<U>父级。foo<>并且bar<U>不会有共同的父母。
    • 如果有多个类模板至少继承了它们的一个模板参数，只要模板类型参数在代码中具有完全相同的名称，Doxygen 就会为这些类模板假定一个共同的父级。这激励了命名的一致性。
    • CRTP 和反向 CRTP 就可以了。
    • 递归模板继承树没有展开。任何variant实例化都将显示为继承自variant<Ts...>.
    • 正在绘制没有实例化的类模板。它们的名称中有一个<...>字符串，表示没有默认值的类型和非类型参数。
    • 类模板完整和部分专业化也正在绘制中。如果特化从不同类型继承，Doxygen 会生成正确的图。
于 2020-01-19T22:37:58.410 回答