java - 用@see 编写正确的javadoc？

Question

如何@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() { .. }
}

Answer 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) { .. }
}