UmlGraph vs APIViz for Maven javadoc generation

时间:2009-11-11 05:37:57

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

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

2 个答案:

答案 0 :(得分:7)

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

  • UMLGraph比较老但是非常好(dixit Fowler比我的重量更重)。
  • apiviz是对UMLGraph的重写,但是为什么重写它并不是很清楚。
  • apiviz的“大”优势是如果没有安装Graphviz,构建将不会失败(虽然在我看来这不能证明整个重写的合理性。)
  • apiviz不会自动生成图表,你必须添加标签而不是UMLGraph默认自动执行(这可能很方便)而所有的全自动结果都很好> UMLGraph还可以使用自定义javadocs标记建模组合关系)。
  • UMLGraph似乎做了更多的事情(“看起来apiviz只是提供了一般化和界面利用的视图”或“ UMLGraph显示的类使用实际上有助于理解一个班级如何工作“)但我没有检查自己,这可能不再是真实的或过时的。

所以,如果你的项目是公开的,那么apiviz在没有Graphviz的情况下优雅地工作的事实很好。如果你有很多类,不得不在javadoc中添加标签,这是一个很大的痛苦。如果您正在寻找特殊功能,UMLGraph可能会提供更多功能。实际上,我认为你应该进行实验,因为你显然对你的需求和最终选择的限制有了更好的了解。

答案 1 :(得分:4)

不正确 apiviz需要注释才能生成图表,因为其文档明确指出:

  

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