Javadocinheritance父构造函数文档
考虑我正在扩展一个类,如:
public class MyComboBox extends JComboBox { public MyComboBox() { super(); } public MyComboBox(ComboBoxModel model ) { super(model); } }
重新定义父的构造函数(当然适合我的新类)很烦人,但是复制每个构造函数的文档甚至更糟。 更不用说它对于进一步inheritance是不好的,因为我现在必须多次更新文档。
显然, {@inheritDoc}
不会起作用,因为我没有压倒任何东西。 然而,这是我正在寻找的行为。 有没有办法实现这个目标?
如何inheritance父构造函数文档?
使用@see标记并输入类和成员名称。 要查看如何显示JDoc ,您可以从javadoc跳转到源代码。
确切的synatax是:
@see com.xyzClassName#methodName()
即使在Java 7中,我们也有一个超类构造函数。
您不能覆盖构造函数,因此不需要传播javadoc。 只需解释对象的客户端需要知道的特定构造函数如何构造对象。 如果它只是将构造传递给扩展对象,那就说出来。