더북(TheBook)

그렇다면 패키지의 JavaDoc 설명서는 어떤 내용을 포함해야 할까요? 아래 방식을 추천합니다.

/**
 * 제품 재고를 관리하는 클래스
 *
 * <p>
 * 주요 클래스는 {@link logistics.Inventory}로서 아래를 수행한다.
 * <ul>
 * <li> {@link logistics.CargoShip}으로 선적하고,
 * <li> 변질된 {@link logistics.Supply}를 모두 버리고,
 * <li> 이름으로 어떤 {@link logistics.Supply}든 찾는다.
 * </ul>
 *
 * <p>
 * 이 클래스는 제품을 내리고 변질된 제품은 즉시 모두 버릴 수 있게 해준다.
 * <pre>
 * Inventory inventory = new Inventory();
 * inventory.stockUp(cargoShip.unload());
 * inventory.disposeContaminatedSupplies();
 * inventory.getContaminatedSupplies().isEmpty(); // true
 * </pre>
 */
package logistics;
신간 소식 구독하기
뉴스레터에 가입하시고 이메일로 신간 소식을 받아 보세요.