java - 如何将图像包含到 javadoc 中并引用它们

Question

我检查了 manual of javadoc并在 stackoverflow 上阅读了一些帖子(例如 Including images in javadocs )但无法获得满意的结果

我想在我的 javadoc 中提供一个图像，它应该与创建的 html 打包在一起。以下是我采取的步骤:

• 创建一个 doc-files以下目录 src/main/java (这是STS中的gradle项目)
• 放置一个名为classhierarchy.png的文件进入新创建的目录
• 添加<img src="doc-files/classhierarchy.png">我类(class)的 javadoc de.company.some.more.levels.MyClass
• 创建 javadoc

我可以看到 png 文件被复制到 C:\temp\NameOfProject\doc\doc-files 但它无法显示，因为 img-link 是相对于包的:c:/temp/NameOfProject/doc/de/company/some/more/levels/doc-files/classhierarchy.png

我知道我可以通过在路径前加上许多/../../来解决这个问题，但如果包深度发生变化，我将不得不调整它:

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

我不喜欢的第二件事是目录 doc-files 与我的源代码位于同一路径。

如何优雅地链接和提供图像？

Answer 1

我至少可以为丰富的“..”提供解决方案。而不是写:

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

我们可以使用:

<img src="{@docRoot}/doc-files/classhierarchy.png">

这将指示 javadoc 插入“..”本身，因此我不必指望自己 ;-) 并且我不必在包结构更改时调整“..”。参数@docroot可以在代码和命令行中使用，详情见the docs

在我的测试中，这与生成的 html 一起工作，并在 Eclipse 中运行。