这个docRoot变量的位置是什么?

问题描述 投票:2回答:1

使用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。感谢您的帮助。

java javadoc
1个回答
2
投票

Javadoc tool documentation清楚地说:

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

这里重要的是它是一个相对路径,无论你在哪个javadoc页面,都指向同一个目录。

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

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

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

在构建过程中添加一个步骤以将JME_License.html复制到生成的Javadoc的根目录,并从任何Javadoc注释中将其称为{@docRoot}/JME_LICENSE.html,这将更容易,更实用。

© www.soinside.com 2019 - 2024. All rights reserved.