棄用方法並鏈接到不同庫中的類

我想棄用某個方法，因爲我想使用不同類中的方法來提供更多標準化的不同庫（jar）。棄用方法並鏈接到不同庫中的類

我想什麼寫的是這樣的：

class MyClass { 

/** 
* @deprecated use {@link com.othercompany.theirmodule.TheirClass.bar() } 
*/ 
@Deprecated 
void foo() { 
... 
}

但是該類TheirClass屬於另一個罐子乾脆。我必須在javadoc'deprecated'標籤中添加一個依賴於它們的模塊的鏈接嗎？

來源

2017-06-14 Breandán Dalton

不，您不需要**將此依賴項添加到您的項目中。假設兩者的工作方式相同，您可以*添加一個依賴項並使用'TheirClass'作爲您現在棄用的方法的實現。你也可以添加一個超鏈接到一些本應該替代你的庫的文檔，或者簡單地提到完整的庫標識符，它們的verion（從最後的形式）和類名，你的用戶可以自己完成所需的步驟。 –

謝謝。所以我只是添加一個超鏈接。 –

@link是javadoc標籤。它用於通過javadoc實用程序從源代碼生成文檔。它也被現代的IDE使用，例如IntelliJ IDEA中的Ctrl+Q顯示關於光標下的類/方法的文檔。

但這只是一條評論。如果ThierClass不可見或者沒有這種方法，IDE可以用紅色突出顯示它，但這對於編譯器來說不是錯誤。

來源

2017-06-14 17:41:19 invenit

棄用方法並鏈接到不同庫中的類

回答

相關問題