是否可以在javadocs中链接自述文件？

Question

我目前将我的自述文件用作一组说明，并希望在javadocs中引用它。我知道可以在javadoc中链接目录，例如，链接我可以做的图像

/**
 * <img src="../../../images/Diagram.png"/>
 */

但是如何链接项目根目录下的自述文件？有可能吗？

Answer 1

基于AdoptOpenJDK集合source code，看起来HTML锚点<a></a>标记用于链接到各个部分的文件。例如在第192-193行，有：

<a href="{@docRoot}/java.base/java/util/package-summary.html#CollectionsFramework">
Java Collections Framework</a>.

您还可以在整个源代码中的其他javadoc注释中看到此内容，因此您应该能够使用要与锚标记链接的非Java类文件的路径。