用@see编写适当的javadoc？

小编典典

用@see编写适当的javadoc？

java

如何@see正确使用Javadoc？

我的意图是拥有一个带有抽象方法的抽象类。这些方法具有javadoc注释。现在，如果我扩展了抽象类，则将覆盖这些方法并要使用@see。

但对于所有的参数，可以如用于return该@see链接似乎没有工作时。Eclipse仍然抱怨expected @return tag。

那么我该如何使用呢？

public abstract class MyBase {
  protected abstract void myFunc();
}

class MyImpl extends MyBase {

  /**
   * @see MyBase#myFunc()
   */
  @Override
  protected void myFunc() { .. }
}

阅读 283

2020-12-03

共1个答案

小编典典

为了包括超类的文档，您不应使用{@inheritDoc}not @see。

然后，您将获得超类的文档。您可以添加它，并且可以覆盖诸如@param和@return所需的东西。

public abstract class MyBase {
  /**
   * @param id The id that will be used for...
   * @param good ignored by most implementations
   * @return The string for id
   */
  protected abstract String myFunc(Long id, boolean good);
}

class MyImpl extends MyBase {

  /**
   * {@inheritDoc}
   * @param good is used differently by this implementation
   */
  @Override
  protected String myFunc(Long id, boolean good) { .. }
}

2020-12-03