java - 这个 docRoot 变量的位置是什么？

Question

使用 JavaDoc，我尝试在我的源代码上添加版权声明；为此，我添加了以下行:

CopyRight see the a href="{@docRoot}/C:/Users/ArbolOne/Documents/Dev/Java/CopyRight/JME_LICENSE.html">Copyright.**

这不起作用，点击链接只会显示一个网页，提示“文件未找到”。

但是，如果我将行更改为:

CopyRight see the a href="{C:/Users/ArbolOne/Documents/Dev/Java/CopyRight/JME_LICENSE.html">Copyright.**

显然这不是一个理想的解决方案，因此我的问题是，如何更改此行以使 {@docRoot} 指向正确的位置？此外，这个 docRoot 变量的位置是什么？

我在 Windows 计算机上使用 Eclipse/Java 10。 感谢您提前提供的帮助。

Answer 1

Javadoc tool documentation说得很清楚:

Represents the relative path to the generated document's (destination) root directory from any generated page.

这里重要的是它是一个相对路径，无论您位于 javadoc 的哪个页面，它都指向相同的目录。

例如，java/lang/Object 页面中 {@docRoot} 的值将是 ../..

同样，在 java/util/logging/Logger 页面中，它将是 ../../..

您的问题是您正在使用指定相对路径的构造来指定绝对路径到 JME_LICENSE.html

在构建过程中添加一个步骤，将 JME_License.html 复制到生成的 Javadoc 的根目录，并将其引用为 {@ docRoot}/JME_LICENSE.html 来自任何 Javadoc 注释。