java - 如何标记已弃用的 API 中使用的 Java 私有(private)方法

Question

如何标记已弃用的 API 中使用的 Java 私有(private)方法，这样就清楚了，它们的存在只是因为已弃用的 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() {
// ...
}