8

私はDAOインターフェースとDAOの実装を持っています。インターフェイスの JavaDoc は、Netbeans が DAO メソッドを実装するクライアントに表示するものです。

明らかに、インターフェイスで JavaDocs を維持する必要があります。しかし、それの実装はどうですか？あると便利な反面、重複するので 2 か所で管理する必要があります。

他の Java 開発者が何をしているのか気になります。

4

3 に答える 3

9

実装メソッドが独自の Javadoc を提供しない場合でも、インターフェイス メソッドのドキュメントへのリンクが存在します。/* (non-Javadoc) @see ... */Javadocsがインターフェースのドキュメントを自動的に参照するため、Eclipseが挿入する理由がわかりませんでし た。

例：

public interface Named {
  /** Returns the name. */
  public String getName();
}

public class Thing implements Named {
  // note no Javadocs here
  public String getName() {
    return "thing";
  }
}

を実行した後javadocのThing.getNameの Javadoc は次のとおりです。

getName

public java.lang.String getName()
    Description copied from interface: Named
    Returns the name.
    Specified by:
        getName in interface Named
于 2012-07-26T16:12:58.990 に答える
4

インターフェイスには、基本的にメソッドの機能、パラメーターの説明、戻り値など、コントラクトに関するすべての情報が含まれている必要があります。

インターフェイスの説明から明確でない追加情報がない限り (めったにありません)、実装ドキュメントは単にインターフェイス メソッドにリンクする必要があります。

これは、フェンスの実装側とクライアント側の両方から最も使いやすいとわかった形式です。

于 2012-07-26T14:52:39.807 に答える
2

私のプロジェクトでは、Eclipse は以下のようにドキュメントを自動的に作成します。

     /* (non-Javadoc)
     *  @see com.comp.SomeInterface#method(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
     */
    @Override
    public void method(HttpServletRequest arg0, HttpServletResponse arg1)
            throws Exception {
        // TODO Auto-generated method stub

    }

Ant タスクを使用して javadoc を作成したため、インターフェイスへのリンクが作成されます。

于 2012-07-26T15:06:18.863 に答える