將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項目中沒有任何價值