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

Question

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

您发现某个（其他优秀）类中的某个方法存在安全问题，并且您希望告诉用户再使用该方法不是一个好主意。你是怎么做到的？

Answer 1

我建议弃用该方法。

How and when to deprecate API

  

设计API时，请仔细考虑它是否取代了   旧API。如果确实如此，你希望鼓励开发者（用户）   API）迁移到新API，然后弃用旧API。有效   弃用API的原因包括：

     

它是不安全的，错误的，或非常低效的

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