当前位置: 首页 > 面试题库 >

是否应该在实现中添加Javadoc注释?

武友樵
2023-03-14
问题内容

在界面中添加Javadoc注释并在实现中添加非Javadoc注释是否正确?

当您自动生成注释时,大多数IDE都会为实现生成非JavaDoc注释。具体方法不应该有描述吗?


问题答案:

对于仅实现(不是覆盖)的方法,请确定为什么不这样做,尤其是如果它们是公共的。

如果您处于压倒一切的情况,并且打算复制任何文本,那么绝对不能。复制是导致差异的必经之路。结果,用户将基于检查父类型还是子类型中的方法而对您的方法有不同的理解。使用@inheritDoc或不提供文档-
IDE将在Javadoc视图中使用最少的可用文本。

顺便说一句,如果您的压倒性版本在超类型的文档中添加了内容,那么您可能会遇到麻烦。我在攻读博士学位期间研究了这个问题,发现一般而言,如果人们通过一个超类型进行调用,他们将永远不会意识到替代版本中的额外信息。

解决此问题是我构建的原型工具的主要功能之一-
每当调用方法时,您都会得到一个指示,即该方法的目标或任何潜在的超越目标是否包含重要信息(例如,行为冲突)。例如,调用在地图上放置时,会提醒您,如果您的实现是TreeMap,则您的元素需要具有可比性。



 类似资料:
  • 问题内容: 在Java中重写非虚拟方法时,建议使用批注,但是如果我实现抽象方法怎么办?我也应该使用吗? 问题答案: 在这种情况下,我倾向于使用,以便在超类发生更改(完全删除方法或更改其签名等)时在子类中标记该方法。 唯一真正的区别是,如果没有注释,则如果更改或删除了超类/接口中的方法,则所讨论的实现将变成该类的“常规”方法。因此,如果仅为了履行合同而实施方法,则应添加注释。如果该方法在您的类中是有

  • 问题内容: 要锁定项目上安装的依赖项的版本,该命令将创建一个名为的文件。这是从Node.js v8.0.0和npm v5.0.0开始的 ,您可能已经知道了。 尽管有Node.js和npm关于提交此文件的建议,但是关于何时应避免这样做的一些担忧也是一个选择。通常,我们致力于项目,但这是一个奇特的问题。 虽然我们默认情况下应该提交文件,但是我们有一个特定的情况,我们不应该提交。例如,如果我们要测试项目

  • 问题内容: 我通常如何在eclipse中为不同的软件包添加javadoc。 例如: 我想在eclipse中添加所有用于hibernate的javadoc,但是我不知道如何。我已经读过这篇文章如何在Eclipse中添加hibernatejavadocs?但我不想使用hibernate工具,因为我已经使用过STS,而且我不理解其他注释。 我在Ubuntu上使用eclipse。 问题答案: 另一个选择是

  • 引用Laravel出纳文件: 如果您希望在为客户提供试用期的同时,仍然提前收集付款方式信息,则在创建订阅时应使用trialDays方法。 假设我想在订阅中添加30天试用期,我可以使用以下代码创建订阅: 作为条带用户,我是否也应该在条带计划中添加试用期? 我不确定是否理解拉威尔出纳的逻辑。在两个不同的地方申报似乎是多余的。

  • 我正在使用Spring开发一个应用程序。我需要使用注释。我有和,这样。这里我很困惑应该在哪里保留注释。 我应该用注释接口还是实现?这两种做法有何不同?

  • 对于不改变实例状态的函数,方法的javadoc注释通常与Java-API中@return-tag的注释相同或非常相似。 boolean Collection.IsEmpty() 如果此集合不包含元素,则返回true。 如果此集合不包含元素,则返回:true 现在我正在为许多简单的方法编写javadoc,比如getExpression(),在这些方法中我遇到了同样的问题。我应该像在API中那样做还是