Является ли Javadoc правильным способом сообщить пользователю о проблеме безопасности?

Question

Я пытаюсь ответить на этот вопрос, и я верю, что Javadoc решит проблему:

Вы обнаружили, что метод в одном из ваших (в противном случае превосходных) классов имеет проблему с безопасностью, и вы хотите сказать пользователям, что использование метода больше не является хорошей идеей. Как ты это делаешь?

Answer 1

Я бы предложил отказаться от метода.

Как и когда отказаться от API

При разработке API тщательно продумайте, заменяет ли оно старый API. Если это так, и вы хотите поощрить разработчиков (пользователей API) к переходу на новый API, то не используйте старый API. Допустимые причины для отказа от API включают в себя:

Это небезопасно, глючит или крайне неэффективно

Это будет автоматически включено в Javadocs и даст четкий сигнал, что этот метод не должен использоваться.