如何标记已弃用的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

API中永远不会公开private方法，因此没有理由对其进行标记，因为API的用户不会对它们有所了解。

此外，如果您使用的是任何IDE，则未使用的私有方法将突出显示为method is never used。