如何在JavaDoc中使用@docRoot？

我在Eclipse項目中使用了JavaDoc註釋。我有一個形象（PNG）我做一個路徑的<img>元素是項目中的文件夾中。問題在於它是硬編碼的：C:\FilePath\...\image.png。如果另一個人想要在他們的計算機上查看此項目，由於硬編碼路徑，它不會顯示該圖像。如何在JavaDoc中使用@docRoot？

我偶然在@docRoot，但我找不到任何地方，顯示如何使用它。例子將不勝感激。 我需要在我的項目在同一位置的相對路徑，所以我可以顯示任何計算機上PNG。

來源

2012-09-26 Jon

下面是從Javadoc中的Android的SDK安裝的文件中Button.class的提取物。

* . . . 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。

來源

2013-05-16 05:03:28 ilomambo

合作哇，這真是棒極了！感謝您用這麼一點興趣來重新提出一個死去的問題。這是一件很小的事情，但是我很震驚這種文檔很少。 – Jon

@Jon好吧，我正在研究自己關於\ @docRoot的問題，並且遇到了您的問題，至今沒有共享我發現的內容。我應該如何設置\ @docRoot我也會在這裏發佈。 – ilomambo

在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時發生問題 file：/// home-falko/camunda/eclipse-workspace/compensation-triggered-from-outside/src/test/java/com/camunda/demo/compensation_triggered_from_outside/{@docRoot } /target/process-test-coverage/report.html

雖然這要根據Eclipse JDT 3.5 Release Notes

來源

2016-08-18 14:26:54

如何在JavaDoc中使用@docRoot？

回答

相關問題