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

标签 java javadoc

<分区>

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

您发现您的一个(其他方面非常出色的)类中的方法存在安全问题,并且您想告诉用户不再使用该方法是个好主意。你是怎么做到的?

最佳答案

我建议弃用该方法。

How and when to deprecate API

When you design an API, carefully consider whether it supersedes an old API. If it does, and you wish to encourage developers (users of the API) to migrate to the new API, then deprecate the old API. Valid reasons to deprecate an API include:

It is insecure, buggy, or highly inefficient

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

关于java - Javadoc 是告诉用户安全问题的正确方法吗?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/15150361/

相关文章:

java - 我可以在 Spring RESTful MVC JSON 序列化中抑制公共(public) bean 属性吗?

java - 如何 : JTextPane auto wrapping NOT on word boundary such as "space", 但在字母边界上

java - 如何更改 Java 评论模板?

java - 如何使用 Bootstrap 主题生成 JavaDoc?

java - 如何从 javadoc 中的另一个注释位置超链接一个注释

java - 为基于注释的 Spring MVC Controller 设置混合配置

java - Android - 加载库失败

java - Android 表未创建

java - 从特定类中删除 javadoc Sonar 检查

java - 删除 JavaDoc 注释的工具?