弃用一组相关方法的最佳做法是什么？

Question

我想弃用一种方法。它调用了一些现在已经过时的辅助方法，并且通过现在​​已经过时的测试在几个地方运行。换句话说，我在整个项目中有一组相关的方法/类/测试，它们都是同一个弃用的一部分，应该同时删除。

当我稍后回来尝试删除顶级方法时，我怎么能确定我找到了所有相关内容？显然，我可以在某处保留自己的笔记，告诉我要删除哪些相关方法。如果做不到这一点，我可以1）删除端点，2）寻找失败的测试并删除它们，3）依靠IDE来查找现在未使用的方法并删除它们，但这似乎容易出错。< / p>

是否有一种标准做法来弃用一组相关的方法/类/测试以确保它们将在以后同时被删除？

Answer 1

最佳做法是使用某种项目/问题跟踪 -

创建一个任务（例如：JIRA-224）并写下应该替换的内容和方法。

为所有方法添加注释：

/**
 * method that does nothing
 *
 * @deprecated will be removed in JIRA-224.  
 */
@Deprecated
public void old() {
// .....
}

准备好后，分配执行任务的人员可以在所有文件中搜索“JIRA-224”并删除方法。

Answer 2

在方法上使用@java.lang.Deprecated。别忘了javadoc：

/**
 * Does some thing .
 *
 * @deprecated use {@link #new()} instead.  
 */
@Deprecated
public void old() {
// ...
}

Answer 3

我不知道具体的做法甚至是工具。其中：诸如eclipse之类的工具可以轻松地为未使用的私有方法提供警告。

无论如何，我建议简单地“做笔记”。含义 - 在您的错误跟踪系统中打开一个缺陷，只需列出您稍后要删除的方法和测试。所以你有一个地方可以概述你的计划。

如上所述：有一些工具可以告诉我们未使用的方法。只需在删除已弃用的方法之前运行该工具。之后再次运行它 - 然后再次运行工具时添加的新消息。