在javadocs中包含图像

我使用了很多可视化的示例测试用例。是否有任何方便的方法将它们包含在Java源代码中并链接到javadoc中，这样我的IDE可以在编码时自动显示它们（通过调用IDE中的javadoc渲染器功能？）

我试着在Java源代码旁边放置一个图像，并使用

，但没有效果（我使用了png）

---

（注意-在本例中是在我的测试源中）

由于您没有显示任何源，我只能做一个玻璃球猜测

对于出于文档目的而需要的任何文件，应将它们放在包目录中名为

doc files

的子目录中。然后，Javadoc将这些文件简单地复制到输出目录。然后在

元素中使用相对路径

---

我不确定您的IDE的Javadoc渲染器是否也会这样做，但值得一试。

有点牵强，但您可以通过将图像转换为Base64来内联文档中的图像。它看起来是这样的：

<img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADIA..." />

有在线工具可用于进行转换：

---

使用Eclipse Luna，以下内容对我很有用

• com
  • 公司
    • 包裹
      • 文档文件
        • image.png
      • Test.java

现在在Test.java的javadoc中：

/**
 * <img src="./doc-files/image.png" />
 */

/**
* 
*/

Eclipse会在弹出式帮助（鼠标悬停时）和Javadoc视图中显示该图像

---

您甚至可以将

style=“width:100%；”

添加到

img

标记中，这样图像就可以根据视图/弹出窗口大小进行调整。

对Paŭlo的答案进行一点扩展，假设maven构建在JDK-8（更严格的HTML验证）中对我起作用，并规定您愿意运行javadoc工具

不幸的是，对于Netbeans，我无法在IDE的javadoc弹出窗口中看到图像，我只是打开了它

假设这是com.foo.File.java的javadoc的一部分（请注意，没有img end标记，这是W3s的正确方法）：

---

我偶然发现了这个问题，因为我也想展示我的图标预览。读完答案后，我还不满意，自己试了试。这就是我现在得到的：

     /**
     * <img src="../../../../../../resources/com/my/project/client/images/myImage.png"><br>
     * Icon for myImage.
     *
     * @return the icon
     */

/**
*

*myImage的图标。
*
*@返回图标
*/

---

像这样，我不需要通过简单地转到实际图像所在的文件夹来管理比以前更多的图像。

要对上面的Vsevolod Golovanov和Paulo Ebermann的回答展开一点讨论，下面是一个具体的示例和进一步的阐述

Javadocs文档说明：

要包含未处理的文件，请将它们放在名为doc files的目录中，该目录可以是包含源文件的任何包目录的子目录

如果将图像文件放在该文件夹中，则Javadocs HTML文件将通过生成的HTML的相对路径访问这些图像文件

因此，如果您的项目名为MyProject，并且要向其添加Javadoc注释的类为org.foo.app.MyApp，源文件夹为MyProject/src/org/foo/app/MyApp.java，并且您希望在其Javadoc中包含MyImage.jpg，那么：

创建文件夹MyProject/src/org/foo/app/doc files，并将图像文件放在其中

此时，您的Javadocs文本可以引用它，因此：

<img src="doc-files/MyImage.jpg" width="500" alt="description of MyImage">

而Javadocs生成的HTML将被相应地编码

请注意“宽度”属性，它允许缩放图像。高度按比例缩放

运行Javadocs时，doc files文件夹将全部复制到Javadocs输出文件夹，其中的资源将可供HTML使用

这样试试

/**
 * @author KamyninSA
 * @version 1
 * <p><b>Description</b></p>
 * <p><img src="{@docRoot}/../src/test/resources/doc-files/ads.png" alt="alternative directory"></p>
 * */

/**
*@作者卡米尼萨
*@version 1
*描述

*

* */

为什么不向我们展示一下您试图用一些代码做什么？使用链接添加它。祝你好运！：）这就是你想要达到的目的吗？谢谢-但这需要我运行javadoc实用程序，我希望避免（并且可能使这种情况变得不可能…）将图像上传到一个网站，就像是一种享受：

@BradTurek这似乎是一个糟糕的计划。当一些随机网站移动或关闭时，文档不应消失。使用最新的IntelliJ（2020），这是开箱即用的（cf.）-您可以将它们放在任何路径中，渲染的文件并不重要，您只需要使用适当的相对路径引用它们（即src='doc-files/img.png'）。注意：如果您使用的是Scala，ScalaDoc出现了一个问题，该问题最近得到了修复（修复可能需要几个月才能进入稳定的插件版本）。您可以使用Paulo解释的普通图像，但这意味着要管理一个单独的文件。inteliJ看不到imageI在显示图像时也使用了base64编码。从IntelliJ运行应用程序时，图像有时显示为空白。但是，当应用程序在部署后隔离运行时，也可以使用相同的方法。我做错了什么？Android Studio 3.0（又称IntelliJ）在“快速文档”弹出窗口中显示图像。

<img src="doc-files/MyImage.jpg" width="500" alt="description of MyImage">

/**
 * @author KamyninSA
 * @version 1
 * <p><b>Description</b></p>
 * <p><img src="{@docRoot}/../src/test/resources/doc-files/ads.png" alt="alternative directory"></p>
 * */