【问题标题】:Creating an overall class diagram with Doxygen使用 Doxygen 创建整体类图
【发布时间】:2021-08-30 07:43:51
【问题描述】:

我正在尝试为我的 Python 项目生成 Doxygen 文档。 似乎 Doxygen 没有提供包括 Association 在内的项目的整体类图。它仅显示单个文件的继承。 有没有办法可以在 doxygen 中生成整体类图?

非常感谢!

【问题讨论】:

标签: doxygen


【解决方案1】:

Doxygen 不会生成包含“关联”箭头的类图。 这些是图表类型和我对它们的体验(源于 C++):

CLASS_DIAGRAMS:似乎是一个旧的 Doxygen 选项,被 CLASS_GRAPH 取代,其中包含更多信息。 CLASS_DIAGRAMS 通常只在我的输出中显示类而没有任何其他内容,这是多余的。

CLASS_GRAPH:这实际上是一个继承图,而不是完整的类图(在内部,它甚至被称为“继承图”)。如果一个类不是派生类或基类,它根本不会显示图表。

COLLABORATION_GRAPH:显示基类、成员关系和模板关系。不显示“继承”或“使用”关系。对于叶类,继承图(CLASS_GRAPH)只是 COLLABORATION_GRAPH 的一部分。

TEMPLATE_RELATIONS:以与继承类似的样式显示模板关系,这对于使用模板特化而不是继承的代码很有帮助,例如CRTP。

你有一个 python 项目,你试过 Sphinx 吗? sphinx.ext.inheritance_diagram 包含在 sphinx-doc 发行版中,但也没有显示除继承之外的其他类型的关系。 网络搜索结果为https://pypi.org/project/sphinx-pyreverse/,这可能就是您要查找的内容。我自己没有尝试过。

【讨论】:

  • 您好,感谢您的回复。我会检查 pyreverse 看看。
猜你喜欢
  • 2021-01-20
  • 2011-06-12
  • 1970-01-01
  • 2015-12-10
  • 2011-09-23
  • 1970-01-01
  • 2012-05-04
  • 2018-01-18
  • 2017-01-16
相关资源
最近更新 更多