删除不推荐API的路径

Question

我们的代码库中有一些外部API，这些API多年来一直被废弃，没有明确的路径来删除它们。你建议我们怎样才能把它们移走？我们是否可以考虑那些已经被废弃的API，例如，>2年或3个版本，足够老到足以删除它们吗？或者，我们是否应该首先为每个API清楚地传达一个删除策略，然后开始提前删除它们几个版本？

有什么见解吗？你是怎么处理的？

Clarification：我们在不推荐的接口上总是有不推荐的注释，问题是当这些注释可能不再存在的时候，我们就再也没有清晰地交流过了。

Answer 1

当我们不推荐一个API时，我们会向我们的用户宣布不推荐的API，并将被弃用的API保留在另外两个版本中。但是，为了确保每个人都知道API是不推荐的(语言是C)，我们在使API公开的头中添加了一个#error This module is deprecated since ...。

保持该状态，直到最终决定删除API。

Answer 2

我想说，这主要取决于谁使用您的API。如果您的API被您无法控制的用户所使用，您需要更加小心地更改它。如果它是在内部严格使用的，那么它主要是QA问题--你怎么能确定没有什么东西还在调用旧函数呢？

我在一些(非常小的)项目中采取的一般方法是调整调用方，使其不再使用旧API，然后记录旧API函数不再受支持(可能只需要源注释，这取决于您的情况)。然后，在测试新API的完整测试/发布周期之后，我们将完全删除旧函数，然后运行另一个完整的测试/发布周期，以确保不会错过对旧API的任何隐藏调用。

根据确切的API，您可能可以在旧函数中放入一些调试代码，以便在某人仍在使用(或错误地开始使用)旧API时找到证据。

Answer 3

在某些编程语言/环境中，您可以将函数修饰为不推荐的函数，或者在调用编译器警告/消息时至少插入它们。这是一个很好的提醒策略(窃听？)用户停止使用这些函数。