interface CargoShip {
    Stack<Supply> unload();
    /**
     * {@link Supply}를 싣는다.
     *
     * @param {@link Queue} 타입의 제품 제공
     * @return {@link Queue} 타입의 적재되지 않은 제품
     */
    Queue<Supply> load(Queue<Supply> supplies);

    int getRemainingCapacity();
}

클래스와 인터페이스(3.8 클래스와 인터페이스를 JavaDoc으로 구조화하기)를 넘어 이제 메서드를 위한 JavaDoc 주석으로 한 단계 더 깊이 들어가겠습니다.

메서드는 객체의 동작을 표현합니다. 메서드를 호출하면 상태 변경과 부수 효과가 발생합니다. 그래서 다른 어떤 JavaDoc 주석 유형보다 메서드의 JavaDoc 설명이 중요합니다. 대부분의 현대 IDE만 보더라도 알 수 있어요. IDE는 메서드의 JavaDoc 주석에서 추출한 내용을 기반으로 프로그래머에게 호출할 메서드를 선택하게 해줍니다. 일반적으로 JavaDoc을 빠르게 조회하는 함수도 지원합니다.

예제에서 사용한 요약문과 @link 표기는 어떤가요? 앞에서 자주 그랬듯이 주석은 유용한 정보를 별로 제공하지 못 합니다.

그러면 나머지 주석 두 줄, @param으로 표시한 입력 매개변수와 @return으로 표시한 반환값은 어떤가요? 새로운 내용 없이 메서드 서명만 반복할 뿐입니다.