当前位置： 文江博客话题详情

Javadoc 插入 UML 图

发布于 2024-08-04 22:49:11 字数 76 浏览 4 评论 0原文

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

谢谢！

原文

Is there a way to embed images into my JavaDoc? Basically i want to include some UML diagrams explaining the hierarchy of my classes in some of the documentation.

Thanks!

如果你对这篇内容有疑问，欢迎到本站社区发帖提问 参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论， 你可以免费 注册 一个本站的账号。

评论（7）

帅哥哥的热头脑 2024-08-11 22:49:11

查看 Javadoc 文档的本节 ，它解释了如何将图像嵌入到 Javadoc 中。

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

Check out this section of the Javadoc documentation, which explains how to embed images in your Javadoc.

Also, here is an article describing how to reverse engineer UML diagrams and embed them in your Javadoc using UMLGraph.

回复 原文
依 靠 2024-08-11 22:49:11

是的。

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

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

Yes.

The documentation explains how to embed arbitrary images to javadoc documentation.

If you want to generate UML class diagrams from your Java source, have a look at the UMLGraph doclet.

回复 原文
清风无影 2024-08-11 22:49:11

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

简而言之：

  1. 安装 GraphViz。

    Ubuntu：apt-get install graphviz4。
    Windows：下载。

  2. 更新 pom.xml。

    <前><代码> <插件>
    maven-javadoc-plugin;
    <版本>2.7
    <配置>
    <聚合>true
    <显示>私人
    org.umlgraph.doclet.UmlGraphDoc

    org.umlgraph;
    doclet
    <版本>5.1

    <附加参数>
    -inferrel -attributes -types -visibility -inferdep -quiet -hide java.* -collpackages java.util.* -qualify -postfixpackage
    -nodefontsize 9
    -nodefontpackagesize 7


  3. 运行mvn javadoc:javadoc。

This article shows how to use UMLGraph with Maven Javadoc plugin.

In short:

  1. Install GraphViz.

    Ubuntu: apt-get install graphviz4.
    Windows: download.

  2. Update 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. Run mvn javadoc:javadoc.

回复 原文
給妳壹絲溫柔 2024-08-11 22:49:11

ApiViz 也是一个不错的 doclet。

ApiViz is a nice doclet too.

回复 原文
单身狗的梦 2024-08-11 22:49:11

简单回答：

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

Simple Answer:

/**
 * This class does some stuff (see diagram).
 * <img src="relative/path/to/image.png" />
 * 
 */
 public class SomeClass{
 }
回复 原文
山人契 2024-08-11 22:49:11

yDoc 是一个选项

yDoc is an option

回复 原文
昔梦 2024-08-11 22:49:11

这篇文章解释了如何做到这一点将图像放置在 javadoc 工具可访问的文件夹中。

This article explains how it can be done by placing your images in a folder accessible to the javadoc tool.

回复 原文
~没有更多了~

关于作者

一生独一

暂无简介

0 文章
0 评论
22 人气
发私信

相关话题

更多

热门标签

操作系统 程序设计 IT运维 Linux系统管理 JavaScript 服务器应用 solaris C/C++ PHP Shell BSD Vue.js aix Oracle Python HTML 系统管理 HTML5 CSS 前端
更多

推荐作者

1CH1MKgiKxn9p

文章 0 评论 0

ゞ记忆︶ㄣ

文章 0 评论 0

JackDx

文章 0 评论 0

信远

文章 0 评论 0

yaoduoduo1995

文章 0 评论 0

霞映澄塘

文章 0 评论 0

更多

友情链接

文江博客
    我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站，即表示您同意使用 Cookies 和您的相关数据。
    原文