Javadoc 继承父构造函数文档

oop inheritance java javadoc

2022-09-03 16:06:59

考虑一下，我正在扩展一个类，例如：

public class MyComboBox<T> extends JComboBox<T> {

    public MyComboBox() {
        super();
    }

    public MyComboBox(ComboBoxModel<T> model ) {
        super(model);
    }

}

重新定义父级的构造函数（当然，这适合我的新类）已经够烦人的了，但是复制每个构造函数文档甚至更糟。更不用说它对进一步继承不利，因为我现在必须多次更新文档。

显然，不会起作用，因为我没有覆盖任何东西。但是，这就是我正在寻找的行为。有没有办法做到这一点？{@inheritDoc}

如何继承父构造函数文档？

答案 1

使用@see标记并输入类和成员名称。要了解它是如何显示的，请查看JDocs，您可以在其中从javadoc跳转到源代码。

确切的 synatax 是：

 @see com.x.y.z.ClassName#methodName()

答案 2

您不能重写构造函数，因此无需传播 javadocs。只需解释对象的客户端需要了解的有关该特定构造函数如何构造对象的信息即可。如果它只是将构造传递给扩展对象，那么就这么说吧。