Javadoc 만들기

Javadoc은 Java 소스 코드로 HTML 형식의 문서를 생성한다.

Java 응용 프로그램을 만들 때, 유지 보수 등을 위하여 각 프로그램의 명세서를 작성해야 하는 경우가 있다. 소스 코드에 포함 된 클래스와 메소드 등을 나중에 조사하여 명세서를 작성하는 것은 쉽지 않은 작업이다.

Javadoc는 JDK에 기본으로 포함되어 있는 프로그램으로 소스 코드에 포함된 클래스나 메소드의 주석(comment)으로 부터 자동으로 명세서를 작성 해주는 편리한 도구이다. 여기에서는 Javadoc의 작성 방법을 중심으로 사용법을 설명한다.

Javadoc에 규칙에 따른 주석을 작성하는 방법을 학습하게 되면, Java 프로그래밍의 주석 작성에 대한 표준도 학습할 수 있다.