用@see编写合适的javadoc？

如何正确使用

@see

javadoc

我的意图是创建一个带有抽象方法的抽象类。这些方法有javadoc注释。 现在，如果我扩展抽象类，我将重写这些方法并希望使用

@see

但是对于所有参数，例如对于

return

，

@see

链接似乎不起作用。Eclipse仍然抱怨

需要@return标记

那我怎么用这个呢

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

class MyImpl extends MyBase {

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

---

为了包含来自超类的文档，您应该使用

{@inheritDoc}

而不是

@请参见

然后你得到超类的文档。您可以添加到它，如果需要，还可以覆盖

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

---

它对我有用。我可以将鼠标悬停在MyImpl.myFunc上，然后看到我在MyBase.myFunc上编写的javadoc。“@see”并不意味着-不需要在这里编写文档。大多数情况下，这并不意味着链接到-为此目的，@link可以如中所述使用