将UML嵌入Java代码中最常用的方法是什么？

Question

我试图将UML序列和类图添加到Java代码中，以解释其内部结构和设计概念。 我希望这些图在JavaDoc块中指定，然后转换为附加到API HTML的PNG / GIF图像。

我可以使用什么工具来自动化该过程（我正在使用Maven 3）？

Answer 1

Javadocs中的UML图 ：本文显示了在Javadoc中包含UML图并随源代码存储库中的每次更改进行更新的过程是多么容易和简单。

Answer 2

我编写了一个使用javadoc绘制动画/图像的ant / maven插件 。

Answer 3

我认为应该更新模型，而不仅仅是将图转换为PNG / GIF等。...生成自动图没有实际价值。 例如，在一个自动生成的图中显示巨大的类及其所有方法（例如有时超过100个）有什么好处？ 您可能会得到巨大的图表，却不明白为什么编写了此代码并且无法理解体系结构等。。。您只是看到了代码的图形视图，这不是UML的目标！

我在项目中为代码做的事情是使用以下功能：

• show hide javadoc在我的UML类图中显示java doc

• 我也使用相反的方法来获得序列图。

• 我最欣赏的是能够在代码中进行实时导航，然后提取模型并仅在模型中进行导航。 我可以为自己想要的任何东西建模，并在为开发人员提供支持之前尝试新的架构。

我认为JavaDoc中包含的自动图生成不是应该做的。 如果您仅手动花费5分钟，就可以使用所有更改来更新现有模型。 您将能够创建自定义的UML视图，在其中可以添加注释。 拥有视图将为团队提供更好的信息，同时节省时间并提高代码质量。

您可以做的是为每个开发人员提供一个UML查看器以及JavaDoc中的链接。 开发人员只需要单击链接，就可以打开自动更新的图表。 不再需要痛苦的图像导出，错误的更新，因为一旦创建了图像，就无法更改它。 您仍然可以创建新图像，但是您松开了注释，演示文稿等.....并且仅获得一个静态的大图，包括所有方法，属性等...无法检测高级关联和依赖关系。 只有继承检测是正确的！

您的UML模型可以与maven和SVN一起使用，并且确实为您的项目和建模带来了真正的价值，这是图像导出无法实现的。 在我看来，您尝试使用UML图只是为了将UML添加到您的项目中，但是添加了一个严重的反向项目的图像导出，该视图没有视图，注释等...不是UML，并且在Java项目中没有任何价值