Java By Comparison

Structure JavaDoc of Methods

interface CargoShip {

    Stack<Supply> unload();

    /**
     * Loads {@link Supply}.
     *
     * @param supplies the supplies of type {@link Queue}
     * @return not loaded supplies of type {@link Queue}
     */
    Queue<Supply> load(Queue<Supply> supplies);

    int getRemainingCapacity();
}

From classes and interfaces (​Structure JavaDoc of Classes and Interfaces​), we are now moving one level deeper to JavaDoc comments for methods.

Methods represent the behavior of objects. By calling methods, you trigger state changes and side effects. That’s why documenting methods with JavaDoc is more important than any other kind of JavaDoc comments. You can even see that in most modern IDEs. They guide the programmer ...