在 javadocs 中包含图像

2022-09-01 07:11:35

我使用了很多可视化的示例测试用例。有没有方便的方法将它们包含在我的Java源代码中并在Javadocs中链接它们,以便我的IDE可以在编码时自动显示它们(通过在我的IDE中调用javadoc渲染器功能?

我尝试将图像放在Java源代码旁边并使用,但它没有采取(我使用了png)。<img>

(注意 - 在这种情况下,它在我的测试源中)


答案 1

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

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

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


答案 2

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

对于出于文档目的所需的任何文件,应将它们放在名为包目录的子目录中。然后,这些将被Javadoc简单地复制到输出目录。然后在元素中使用相对路径。doc-files<img>

我不确定你的IDE的Javadoc渲染器是否会做同样的事情,但它值得一试。


推荐