如何標記棄用API中使用的java私有方法

Question

如何標記棄用API中使用的java私有方法，因此很明顯，它們的存在僅僅是因爲不推薦使用的API不會被移除，並且不應該用於新類' API？

這樣

@Deprecated 
    public void doSomething() { 
     List<String> list = new ArrayList<>(); 
     list.addAll(returnList()); 
    } 

    private List<String> returnList() { 
     return new ArrayList<>(); 
    } 

我想加入

//TODO remove this after #deprecatedMethod is removed 

，但我不知道它是正確的

Answer 1

爲了慶祝不應該使用的方法，你可以聲明方法本身爲@Deprecated，添加註釋的最佳做法是在javadoc字段中進行說明。我還建議建立新的方法和javadoc的鏈接它們，以避免將來出現問題：

/** 
* This method use a deprecated API 
* 
* @deprecated use {@link #newMethodNodeprecated()} instead. 
*/ 
@Deprecated 
public void oldMethod() { 
// ... 
} 

Answer 2

一個private方法是在API中從來沒有接觸，所以應該沒有理由將它們標記，爲的用戶API不會了解它們。另外，如果您正在使用任何IDE，未使用的私有方法將突出顯示爲method is never used。