더북(TheBook)

3.7 패키지를 JavaDoc으로 구조화하기

/**
 * logistics라는 이 패키지는 물류(logistics)를 위한 클래스를 포함한다.
 * 이 패키지의 inventory 클래스는 화물선에 제품을 선적하고,
 * 변질된 제품은 모두 버릴 수 있다.
 * 이 패키지의 클래스:
 * - Inventory
 * - Supply
 * - Hull
 * - CargoShip
 * - SupplyCrate
 *
 * @author A. Lien, H. Uman
 * @version 1.8
 * @since 1.7
 */
package logistics;

JavaDoc*은 자바 API가 제공하는 문서화 기능입니다. 패키지를 비롯해 코드에서 public인 요소를 설명하는 데 사용합니다. API를 작성 중이고 API를 사용하는 데 다른 요소가 필요하다면 반드시 사용해야 합니다.

 

 


신간 소식 구독하기
뉴스레터에 가입하시고 이메일로 신간 소식을 받아 보세요.