是否可以在 javadocs 中 link README 文件?
Is it possible to link README file in javadocs?
我目前将我的 README 文件用作一组说明,并希望在 javadocs 中引用它。我知道可以在 javadoc 中 link 目录,例如 link 我可以做的图像
/**
* <img src="../../../images/Diagram.png"/>
*/
但是如何link项目根目录下的README文件呢?可能吗?
基于 AdoptOpenJDK 集合 source code,看起来 HTML 锚点 <a></a>
标签用于 link 文件的各个部分。例如在第 192-193 行,有:
<a href="{@docRoot}/java.base/java/util/package-summary.html#CollectionsFramework">
Java Collections Framework</a>.
您也可以在整个源代码的其他 javadoc 注释中看到这一点,因此您应该能够使用您想要 [=20] 的非 Java class 文件的路径=] 到锚标签。
我目前将我的 README 文件用作一组说明,并希望在 javadocs 中引用它。我知道可以在 javadoc 中 link 目录,例如 link 我可以做的图像
/**
* <img src="../../../images/Diagram.png"/>
*/
但是如何link项目根目录下的README文件呢?可能吗?
基于 AdoptOpenJDK 集合 source code,看起来 HTML 锚点 <a></a>
标签用于 link 文件的各个部分。例如在第 192-193 行,有:
<a href="{@docRoot}/java.base/java/util/package-summary.html#CollectionsFramework">
Java Collections Framework</a>.
您也可以在整个源代码的其他 javadoc 注释中看到这一点,因此您应该能够使用您想要 [=20] 的非 Java class 文件的路径=] 到锚标签。