java - 为什么 inheritedDoc 没有在构造函数上定义?

标签 java documentation javadoc

<分区>

我想知道 javadoc 不支持 constructors 上的 inheritedDoc 是否有正当理由。假设我有

class A
{
/**
 * Constructor of A
 */
A(){}   

/**
 * Does something
 */
public void method(){}
}

class B extends A
{
/**
 * {@inheritDoc}
 */
B(){ super();}

/**
 * {@inheritDoc}
 */
public void method(){}
}

对于方法method,我可以继承javadoc,但是为什么同样不能应用于constructors?除非我使用 inheritDoc 标记,否则 javadoc 不会被继承,这意味着我很清楚我想要重用文档。什么应该阻止我为 构造函数 这样做?

最佳答案

What should prevent me from doing so for the constructors?

大概是因为构造函数不是继承的。虽然它们经常最终具有与父类(super class)中的构造函数相同的参数(具有相同的含义),但它们的关系并不像方法那样清晰。

我可以看到实用值(value),但同样我可以看到为什么实际上没有继承的东西不应该有 @inheritDoc 可用。如果您可以专门继承文档的,那就太好了——例如,如果您要将参数值直接传递给父类(super class)构造函数,那么能够有效地链接到那个文件...

关于java - 为什么 inheritedDoc 没有在构造函数上定义?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/14848999/

相关文章:

java - 在 NetBeans Maven 项目中设置 linksource 属性

安卓工作室 : can no longer see dependencies javadoc

java - 在 ListView 中加载多个图像

java - 使用java8将字符串转换为日期

perl - 模块 : When should I mention the required Perl version in the documentation?

user-interface - 将文档构建到软件中

java - 包级 Javadoc 文件的空模板

java - GUI编程-定制框架

java - 在类中使用静态方法时没有输出(其中没有 main 函数的类)

documentation - Google Rich Snippet Test Tool 验证面包屑但真正的 Google 结果不显示它