我在 Eclipse 项目中使用 JavaDoc 注释。我有一个图像 (png) 我<img>
为项目文件夹中的元素创建了一个路径。问题是它是硬编码的:C:\FilePath\...\image.png
. 如果另一个人想在他们的计算机上查看这个项目,由于硬编码的路径,它不会显示该图像。
我偶然发现,@docRoot
但我找不到任何地方显示如何使用它。例子将不胜感激。我需要在我的项目中创建一个到同一位置的相对路径,以便我可以在任何计算机上显示该 png。
这是 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。
在 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>
*/
并产生以下错误:
无法加载页面
加载 URL 文件时出现问题:///home-falko/camunda/eclipse-workspace/compensation-triggered-from-outside/src/test/java/com/camunda/demo/compensation_triggered_from_outside/{@docRoot}/target/过程测试覆盖/report.html
虽然这应该根据Eclipse JDT 3.5 发行说明工作