java - Javadoc 是告诉用户安全问题的正确方法吗？

Question

我正在尝试回答这个问题，我相信 Javadoc 会解决这个问题：

您发现您的一个（否则非常出色）类中的方法存在安全问题，并且您想告诉用户不再使用该方法不是一个好主意。你怎么做到这一点？

Answer 1

我建议弃用该方法。

如何以及何时弃用 API

在设计 API 时，请仔细考虑它是否会取代旧的 API。如果是这样，并且您希望鼓励开发人员（API 的用户）迁移到新的 API，那么请弃用旧的 API。弃用 API 的正当理由包括：

它不安全、有缺陷或效率极低

这将自动包含在 Javadocs 中，并给出一个明确的信号，表明不应使用此方法。