【问题标题】:UmlGraph vs APIViz for Maven javadoc generation用于 Maven javadoc 生成的 UmlGraph 与 APIViz
【发布时间】:2010-12-15 08:34:04
【问题描述】:

我想知道是否有任何明确的理由选择 UmlGraph 而不是 APIViz 用于在 Maven2 构建中生成 javadoc UML 图。两者之间是否有任何集成或功能,它们看起来非常相似?

【问题讨论】:

    标签: java maven-2 uml javadoc documentation-generation


    【解决方案1】:

    有一个有趣的线程 here 关于 UMLGraph 与 apiviz(在 SO 上也提到了 in this question),我的理解如下:

    • UMLGraph 较旧,但非常好(dixit Fowler 比我重)。
    • apiviz 是对 UMLGraph 的重写,但不清楚为什么要重写它。
    • apiviz 的“大”优势在于,如果未安装 Graphviz,构建不会失败(尽管在我看来,这并不能证明整个重写的合理性)。
    • apiviz 不会自动生成图形,您必须添加标签,而 UMLGraph 默认会自动生成(这很方便),并且完全自动的结果对所有人来说都很好,也很容易(UMLGraph 还可以使用自定义 javadocs 标签对组合关系进行建模)。
    • UMLGraph 似乎做了更多的事情(“看起来 apiviz 只是提供了泛化和接口利用的视图”或“UMLGraph 显示的类用法实际上有助于理解课程是如何运作的"),但我没有检查自己,这可能不再正确或过时了。

    因此,如果您的项目是公开的,那么 apiviz 可以在没有 Graphviz 的情况下正常运行这一事实很好。如果你有很多类,那么必须在 javadoc 中到处添加标签是一件很痛苦的事情。如果您正在寻找特殊功能,UMLGraph 可能会提供更多。实际上,我认为您应该尝试两者,因为您显然对最终选择的需求和限制有更好的了解。

    【讨论】:

    【解决方案2】:

    apiviz 需要注释来生成图表,这不正确,正如其文档中明确指出的那样:

    APIviz 默认自动发现包和类之间的关系以及它们的构造型。此外,您可以使用以下 doclet 标记来添加更多关系或使生成的图表看起来更清晰。

    【讨论】:

      猜你喜欢
      • 2012-04-15
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 2016-07-01
      • 2013-03-14
      • 2015-06-16
      • 1970-01-01
      • 1970-01-01
      相关资源
      最近更新 更多