Javadoc 插入 UML 圖

Question

有沒有辦法將圖像嵌入到我的 JavaDoc 中？ 基本上我想在一些文檔中包含一些 UML 圖來解釋我的類的層次結構。

謝謝！

Answer 1

查看 Javadoc 文檔的這一部分，它解釋了如何在 Javadoc 中嵌入圖像。

此外，這里有一篇文章描述了如何使用UMLGraph對 UML 圖進行逆向工程並將它們嵌入到您的 Javadoc 中。

Answer 2

是的。

該文檔解釋了如何將任意圖像嵌入到 javadoc 文檔中。

如果您想從 Java 源代碼生成 UML 類圖，請查看UMLGraph doclet 。

Answer 3

本文展示了如何將 UMLGraph 與 Maven Javadoc 插件一起使用。

簡而言之：

1. 安裝 GraphViz。

   Ubuntu： apt-get install graphviz4 。
   Windows：下載.

2. 更新 pom.xml。

    <plugin> <artifactId>maven-javadoc-plugin</artifactId> <version>2.7</version> <configuration> <aggregate>true</aggregate> <show>private</show> <doclet>org.umlgraph.doclet.UmlGraphDoc</doclet> <docletArtifact> <groupId>org.umlgraph</groupId> <artifactId>doclet</artifactId> <version>5.1</version> </docletArtifact> <additionalparam> -inferrel -attributes -types -visibility -inferdep -quiet -hide java.* -collpackages java.util.* -qualify -postfixpackage -nodefontsize 9 -nodefontpackagesize 7 </additionalparam> </configuration> </plugin>

3. 運行mvn javadoc:javadoc 。

Answer 4

ApiViz也是一個不錯的 doclet。

Answer 5

簡單回答：

/**
 * This class does some stuff (see diagram).
 * <img src="relative/path/to/image.png" />
 * 
 */
 public class SomeClass{
 }

Answer 6

yDoc是一個選項

Answer 7

本文解釋了如何通過將圖像放置在 javadoc 工具可訪問的文件夾中來完成此操作。