Javadoc继承父构造函数文档

时间:2013-01-18 15:37:03

标签: java oop inheritance javadoc

考虑我正在扩展一个类,如:

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

    public MyComboBox() {
        super();
    }

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

}

重新定义父的构造函数(当然适合我的新类)很烦人,但是复制每个构造函数的文档甚至更糟。更不用说它对于进一步继承是不好的,因为我现在必须多次更新文档。

显然,{@inheritDoc}不起作用,因为我没有压倒任何东西。然而,这是我正在寻找的行为。有没有办法实现这个目标?

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

3 个答案:

答案 0 :(得分:2)

使用@see标记并将类和&amp;成员名字。要查看显示的内容,请查看JDocs,您可以从javadoc跳转到源代码。

确切的synatax是:

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

答案 1 :(得分:0)

您无法覆盖构造函数,因此无需传播javadoc。只需解释对象的客户端需要知道的特定构造函数如何构造对象。如果它只是将构造传递给扩展对象,那就说出来。

答案 2 :(得分:-1)

即使在Java 7中我们也有一个超类构造函数。

String class has reference to its super class Object

http://docs.oracle.com/javase/8/docs/api/