Javadoc 插入 UML 图答案

【问题标题】：Javadoc Inserting UML DiagramsJavadoc 插入 UML 图
【发布时间】：2010-11-27 12:36:25
【问题描述】：

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

谢谢！

【问题讨论】：

+1 我希望我自己能问这个问题！

标签： java javadoc class-diagram

【解决方案1】：

是的。

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

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

【讨论】：

还有这篇关于使用UML Graph的文章java.dzone.com/articles/reverse-engineer-source-code-u

【解决方案2】：

查看 Javadoc 文档的 this section，它解释了如何在 Javadoc 中嵌入图像。

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

【讨论】：

UML Graph url 已损坏，已更改所有者

【解决方案3】：

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

【讨论】：

【解决方案4】：

ApiViz 也是一个不错的 doclet。

【讨论】：

【解决方案5】：

yDoc 是一个选项

【讨论】：

单用户许可 269.00 美元。
是否有 C# 的开源/免费替代方案？

【解决方案6】：

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

简而言之：

安装 GraphViz。

Ubuntu：apt-get install graphviz4.
窗口：download。

更新 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>

运行mvn javadoc:javadoc。

【讨论】：

显然是最简单的方法！应该为构建这些添加配置文件，这样您就不会破坏路径中没有 GraphViz 的其他 ppl 构建。

【解决方案7】：

简单回答：

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

【讨论】：