將UML嵌入到Java代碼中的最常用方法是什麼？

我想將UML序列和類圖添加到我的Java代碼中，以解釋其內部和設計概念。我希望這些圖表在JavaDoc塊中指定，然後轉換爲附加到API HTML的PNG/GIF圖像。將UML嵌入到Java代碼中的最常用方法是什麼？

我可以使用什麼工具來實現這個過程的自動化（我使用的是Maven 3）？

2010-11-15 yegor256

http://stackoverflow.com/questions/1712125/open-source-tool-to-generate-javadocs-through-maven2-with-automatic-uml-diagrams這可能會有所幫助ü – 2010-11-15 11:58:41

UML Diagrams within Javadocs：本文展示瞭如何簡單和容易地將UML圖包含在Javadoc中，並且隨着源代碼庫中的每一項更改都保持更新。

來源

2010-11-15 11:55:34 dogbane

非常有用的鏈接。謝謝。 – 2010-11-15 11:58:58

我認爲該模型應該更新，而不只是圖轉換爲PNG/GIF等.... 生成自動圖沒有實際價值。例如，在單個自動生成的圖表中顯示一個龐大的課程及其所有方法（例如，有時超過100個）的興趣是什麼？你可能會得到巨大的圖表，不明白爲什麼這些代碼已經寫好，並且無法理解體系結構等等......你只能看到你的代碼的圖形視圖，這不是UML的目標！

我在我的項目，我的代碼做的是使用以下功能：

在我的UML類圖顯示隱藏的javadoc顯示Java文檔
我也用的反向方法來獲得序列圖。
我最欣賞的是能夠在代碼中生活導航，然後提取我的模型並只在模型中導航。我可以對任何我想要的模型進行建模，並在給開發人員團隊之前嘗試新架構。

我認爲包含在JavaDoc中的自動圖表生成不是應該做的。如果您只需手動花費5分鐘，則可以使用所有更改更新現有模型。您將能夠創建自定義的UML視圖，您可以在其中添加註釋。有意見將爲團隊提供更好的信息，同時節省時間併爲代碼添加質量。

您可以做的是爲每個開發人員提供一個UML查看器，並在您的JavaDoc中提供一個鏈接。開發人員只需點擊鏈接，就可以打開將自動更新的圖表。沒有更痛苦的圖像導出，更新錯誤，因爲一旦圖像被創建，就不可能改變它。你仍然可以創建新的圖像，但你鬆散的評論，演示文稿等.....只有一個靜態的巨大的圖，包括所有的方法，屬性等...不能夠檢測高級關聯和依賴關係。只有遺傳檢測纔是正確的！

您可以將UML模型與maven和SVN結合使用，真正爲您的項目帶來實實在在的價值，並且通過圖像導出無法實現建模。在我看來，您嘗試使用UML圖只是爲了將UML添加到您的項目中，但添加了一個沒有視圖，註釋等的嚴重反向項目的圖像導出...不是UML，並且在Java項目中沒有任何價值

來源

2010-11-16 10:09:25

如果你有一個包含100多個方法的類 - 忘記關於UML，請首先重構。 – yegor256 2010-11-16 16:38:19

我在當前項目中有超過300種方法的課程，我可以使用show hide compartment選項顯示我想要的內容。我也可以用非常小的字體顯示這些方法，並將它們全部放入我的圖中。 – 2010-11-17 09:58:07

將UML嵌入到Java代碼中的最常用方法是什麼？

回答

相關問題