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

用@see编写正确的javadoc？

1 个答案: