Question

I have an interface A which has methods x, y and z. I am commenting the class this way:

/**
 * 
 * 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();
}

Is it right or should I add other things to the CLASS COMMENTS?

Answer 1

Yes you should write proper Javadoc comments for your interfaces to clearly specific the motivation behind the interface and what the contract is for both callers and implementors.

Take a look at some of the interfaces in the JDK code for examples, like java.util.List