代码之家 › 专栏 › 技术社区 › Batman

Javadoc和继承的类

instances javadoc inheritance

Batman · 技术社区 · 9 年前

在我的工作场所,我查看了一个Javadoc,发现对于一个特定的方法,返回值是x,而实际上是y(类y继承了类x)。

你怎么认为?我问了设计师,他们告诉我,因为x包含在y中,所以如果在Javadoc中返回x或y,它应该是返回x,这无关紧要。。。我认为这是错误的,因为有两个原因: 1.即使实例保持不变,用户也应该知道他得到的真实对象。 2.用户不应该访问不需要访问的实例。

1 回复 | 直到 9 年前

Erwin Smout 9 年前

您可以在子类方法中声明返回类型y,如果这样做,javadoc将反映这一点。

推荐文章

Stephen.lin · 当鼠标向上移动弹出java文档时,IntelliJ思想如何像eclipse一样工作

7 年前

Vulkanos · 我可以在自定义doclet的帮助下生成Javadoc注释吗?

7 年前

Fraquack · Kotlin-接口方法引发的文档异常

7 年前

Adrien Aacha · Javadocs-@param name未找到

7 年前

Mohan · 为具有(模拟的)可选/默认参数的函数编写Javadoc

7 年前

Jai · vararg方法的Javadoc链接

7 年前

grandouassou · 使用Java Bean验证注释从POJO生成文档

7 年前

drJava · 在JavaDoc中将方法参数与类成员链接

7 年前

Batman · Javadoc和继承的类

9 年前

CrypticStorm · IntelliJ Javadoc每行增加一个星号

10 年前