24

有没有办法将图像嵌入到我的 JavaDoc 中？基本上我想在一些文档中包含一些解释我的类层次结构的 UML 图。

谢谢！

4

7 回答 7

24

查看Javadoc 文档的这一部分，它解释了如何在 Javadoc 中嵌入图像。

此外，这里还有一篇文章描述了如何使用UMLGraph对 UML 图进行逆向工程并将它们嵌入到您的 Javadoc 中。

于 2009-09-11T14:24:26.730 回答
8

是的。

该文档解释了如何将任意图像嵌入到 javadoc 文档中。

如果您想从您的 Java 源代码生成 UML 类图，请查看UMLGraph doclet。

于 2009-09-11T14:24:14.187 回答
5

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

简而言之：

  1. 安装 GraphViz。

    乌班图：apt-get install graphviz4。
    视窗：下载.

  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。

于 2013-01-15T08:43:00.947 回答
3

ApiViz也是一个不错的 doclet。

于 2009-10-07T10:25:36.257 回答
3

简单的答案：

/**
 * This class does some stuff (see diagram).
 * <img src="relative/path/to/image.png" />
 * 
 */
 public class SomeClass{
 }
于 2014-02-03T03:31:32.107 回答
2

yDoc是一个选项

于 2011-01-04T16:39:06.417 回答
0

本文解释了如何通过将图像放置在 javadoc 工具可访问的文件夹中来完成此操作。

于 2009-09-11T14:25:31.640 回答