Question

我在Eclipse项目中使用JavaDoc注释。我有一个图像（png）我创建了一个<img>元素的路径，该元素位于项目的文件夹中。问题是它是硬编码的：C:\FilePath\...\image.png。如果另一个人想要在他们的计算机上查看该项目，由于硬编码路径，它将不会显示该图像。

我偶然发现了@docRoot，但我找不到任何显示如何使用它的地方。举例非常感谢。 我需要在项目中创建相同位置的相对路径，以便在任何计算机上显示该png。

Answer 1

以下是android-sdk安装文件Button.class中javadoc的摘录。

 * . . .   For more information and an example, see <a
 * href="{@docRoot}guide/topics/resources/drawable-resource.html#StateList">State List
 * Drawable . . .

这里@docRoot用于撰写对html教程的引用。就我而言，@ docRoot转换为以下路径：

file:/C:/Users/<username>/AppData/Local/Android/android-sdk/docs/reference/

我用'/'结束了路径虽然实际上似乎存在问题，但@docRoot中缺少最后一个斜线，使所有这些参考路径都变坏了。
如果使用它，请确保在{@docRoot}之后添加斜杠。我还没有找到是否可以更改@docRoot。

Answer 2

在Eclipse JDT 4.4.1中，我不得不使用：

    /**
     * @see <a href="../../../../../../../target/process-test-coverage/report.html">Process Test Coverage Report</a> 
     */
    public void calculateCoverageForAllTests() throws Exception {
        ...
    }

因为{@docRoot}似乎在Javadoc视图中无效并且悬停：

    /**
     * @see <a href="{@docRoot}/target/process-test-coverage/report.html">Process Test Coverage Report</a> 
     */

并产生以下错误：

无法加载页面

加载网址时出现问题   文件：///家庭falko / camunda / Eclipse的工作空间/补偿 - 触发的从外线/ src目录/测试/ JAVA / COM / camunda /演示/ compensation_triggered_from_outside / {} @docRoot /目标/流程测试覆盖/ report.html

虽然这应该根据Eclipse JDT 3.5 Release Notes

工作

如何在JavaDoc中使用@docRoot？

2 个答案: