说明
详情可以阅读:
https://docs.oracle.com/en/java/javase/19/docs/specs/javadoc/doc-comment-spec.html#method-comment-inheritance
-
子类继承父类、或者子类实现接口,在子类中为了避免重复写注释,可以在子类方法注释的主要描述部分、或者@return、@param、@throws标记后面的文本参数部分插入{@inheritDoc}标记,来明确继承javadoc注释。
-
注意:构造函数、属性、嵌套类不继承javadoc注释。
-
如果不写明确继承标记{@inheritDoc},可能可以自动继承javadoc注释,也可能无法自动继承。
-
在子类的方法中,如果觉着有些javadoc注释不需要继承,而要写个性化的,那就在子类的方法javadoc注释中重写这部分,其它的照样继承。例如注释的主要描述部分重写了,而参数、返回部分继承,是可以的。总之,就是缺哪一部分继承哪一部分。
示例
定义一个接口:
package com.thb;
public interface Parent {
/**
* 返回姓名的全称.
* @param firstName 名字
* @param secondName 姓
* @return 姓名的全称
*/
String method(String firstName, String secondName);
}
定义一个子类实现接口:
package com.thb;
public class Child implements Parent {
/**
* {@inheritDoc}
* @param firstName {@inheritDoc}
* @param secondName {@inheritDoc}
* @return {@inheritDoc}
*/
@Override
public String method(String firstName, String secondName) {
return firstName + secondName;
}
}
运行javadoc命令生成帮助文档:
打开生成的帮助文档,看看内容: