此docRoot变量的位置在哪里?

时间:2018-09-03 16:33:26

标签: java javadoc

使用JavaDoc,我试图在源代码上添加一个CopyRight通知;为此,我添加了以下行:

  

CopyRight,请参见a href =“ {@ docRoot} /C:/Users/ArbolOne/Documents/Dev/Java/CopyRight/JME_LICENSE.html”>版权。**

这不起作用,并且在链接上单击仅会显示一个网页,显示“找不到文件”。

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

  

CopyRight,请参阅a href =“ {C:/Users/ArbolOne/Documents/Dev/Java/CopyRight/JME_LICENSE.html”>版权。**

显然这不是理想的解决方案,因此,我的问题是,如何更改此行以使{@docRoot}指向正确的位置?而且,此docRoot变量的位置在哪里?

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

1 个答案:

答案 0 :(得分:2)

Javadoc tool documentation清楚地说:

  

表示到生成的文档(目标)的相对路径   任何生成的页面的根目录。

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

例如,页面中{@docRoot}的{​​{1}}的值为java/lang/Object

类似地,在../..的页面中,它将是java/util/logging/Logger

您的问题是您使用的结构指定了 相对 路径来指定 绝对 路径到../../..

对于您来说,在构建过程中添加一个步骤来将JME_LICENSE.html复制到生成的Javadoc的根目录,并在任何Javadoc注释中将其称为JME_License.html,这将更加容易和实用。