ip地址直接访问网站,邯郸信息港官网登录,做个网站需要学会什么,百度指数明星搜索排名没有什么事情比看到一个没有任何说明的deprecated标注更让人愤怒的事情了。这种做法只能让人困惑#xff0c;我到底还要不要用这个已经‘废弃’的方法#xff1f;如果开发者不希望某个方法再被人用的话#xff0c;就要好好地为deprecated标注写说明。这篇文章就讨论了正确地…没有什么事情比看到一个没有任何说明的deprecated标注更让人愤怒的事情了。这种做法只能让人困惑我到底还要不要用这个已经‘废弃’的方法如果开发者不希望某个方法再被人用的话就要好好地为deprecated标注写说明。这篇文章就讨论了正确地使用deprecated 标注需要遵守的一些规则。 什么是使用Deprecated标注的规则? Rule #1: do Javadoc how not to 每当你弃用某方法时创建JavaDoc告诉其他程序员如何不再使用这个方法。不要只说“这个方法废弃了不要用它”。因为这就是废弃标注和JavaDoc中deprecated的字面意义完全没有必要再重复一遍。Java开发人员作为目标受众都知道deprecation的意思。 命名新的方法取代旧有的。(使用link标注!)这可能还不够新的方法对应的文档将解释如何使用它。不要在JavaDoc中重复其字面意义文档也应遵从DRY原则。另一方面你可能想要描述怎样替换掉旧方法的调用你可以就重构的细节给出提示。 Rule #2: do not Javadoc how to 移除过时的JavaDoc文档。有些人可能争辩维护遗留代码的用户可能还会需要这些文档。事实上他们使用的是旧版本库中的旧版本方法。旧版本的文档仍旧存在那里像被刻在石头上更确切的说是刻在资源仓库的某个版本上。含有被废弃掉的方法的实际版本不应包含过时的描述文档那会鼓励程序员去继续使用。对于废弃的方法只有一种用法不去用。JavaDoc应该被实时描述如同rule#1所述。 Rule #3: 不要在JavaDoc中解释 不要在JavaDoc中解释为什么方法被废弃了。你是一个可靠的的开发这是你的决定你的选择其他人只能忍着。如果愿意可以写一篇博客记录这次调整的决策背景。这可能有帮助但它不应被写在JavaDoc中。 JavaDoc的Deprecated API专用来讲解如何不再使用。 重点是如何(how)。而不是“为什么不再使用它(why)”。 Rule #4: do deprecate 如果你觉得需要弃用一方法那就去做吧如果你害怕你的用户或不想因你废弃掉一些方法导致你用户体验更加痛苦这个决定将让你自己痛苦。尽你所能去让API维持长久的稳定。但如果有需要被废弃的立刻扔掉它。不要因“为何当初设计API时没有考虑到未来的变动”而感到愧疚。没有人能完美的预见未来。毕竟如果你知道未来生活就无趣了。 原文链接 javacodegeeks翻译 ImportNew.com - dust_jead译文链接 http://www.importnew.com/10113.html转载于:https://www.cnblogs.com/yuyu666/p/9842810.html
