Java 文档重写方法不具有 InheritDoc

2024-03-19

重写另一个方法的方法不会继承它所重写的方法的文档。有没有办法明确告诉它继承文档?

/**
  * {@inheritDoc}
  * 
  * This implementation uses a dynamic programming approach.
  */
@Override
public int[] a(int b) {
    return null;
}

根据javadoc文档 http://java.sun.com/javase/6/docs/technotes/tools/solaris/javadoc.html:

注释的继承发生在所有 三种可能的继承情况 来自类和接口:

  • 当类中的方法覆盖超类中的方法时
  • 当接口中的方法覆盖超级接口中的方法时
  • 当类中的方法实现接口中的方法时

可以使用显式继承注释{@inheritDoc} http://java.sun.com/javase/6/docs/technotes/tools/solaris/javadoc.html#@inheritDoc标签。如果没有为重写方法提供注释,注释将被隐式继承。如果您愿意,可以覆盖继承注释的各个方面(例如参数、返回值等)。

重要的是,您需要确保包含要继承的注释的代码的源文件可供 javadoc 工具使用。您可以使用 -源路径 http://java.sun.com/javase/6/docs/technotes/tools/solaris/javadoc.html#sourcepath option.

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

Java 文档重写方法不具有 InheritDoc 的相关文章

随机推荐