[解決済み] JavaDocインターフェイスのコメント [終了しました］

質問事項

メソッドx,y,zを持つインターフェースAを持っています。

/**
 * 
 * A.java
 * Interface class that has the following methods.
 * 
 * @author MyName
 * @since mm-dd-yyyy
 */

public interface A {

    //method description for x
    void x();

    //method description for y
    void y();

    //method description for z
    void z();
}

これで良いのか、それともCLASS COMMENTSに他のものを追加した方が良いのか？

どのように解決するのですか？

インターフェースの背後にある動機と、呼び出し側と実装側の両方にとっての契約が何であるかを明確にするために、適切なJavadocコメントを書く必要があることは言うまでもありません。

JDKのコードにある、以下のようなインターフェースの例を見てみましょう。 java.util.List