用@see 编写正确的javadoc？答案

【问题标题】：Writing proper javadoc with @see?用@see 编写正确的javadoc？
【发布时间】：2012-06-22 17:02:48
【问题描述】：

如何正确使用@see javadoc？

我的目的是创建一个带有抽象方法的抽象类。这些方法有 javadoc cmets。现在，如果我扩展抽象类，我会覆盖方法并希望使用@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() { .. }
}

【问题讨论】：

它对我有用。我可以将鼠标悬停在 MyImpl.myFunc 上并按 F2 并查看我在 MyBase.myFunc 上编写的 javadoc。
"@see" 并不意味着 - 无需在此处记录。大多数情况下，这并不意味着链接到 - 为此目的，@link 可能会按照stackoverflow.com/questions/5915992/…中的概述使用@

标签： java javadoc

【解决方案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) { .. }
}

【讨论】：