web-dev-qa-db-ja.com

@seeを使用して適切なjavadocを作成しますか？

@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() { .. }
}
javajavadoc
14
membersound

スーパークラスのドキュメントを含めるには、{@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) { .. }
}
13
Superole