Javadoc 만들기

자바 문서 만들기

Javadoc 만들기

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

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

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

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


Javadoc 기본

Javadoc로 생성되는 문서의 확인 및 Javadoc에 대응한 코멘트의 기술 방법 등 Javadoc의 기본 사항을 설명한다.

Javadoc 주석 서식

Javadoc로 생성되는 문서의 확인 및 Javadoc에 관련된 주석 작성 방법 등에 대한 Javadoc 기본 사항을 설명한다.

Javadoc 태그

주석에는 설명문과 Javadoc 태그를 작성할 수 있다. 여기에서는 Javadoc 태그에 대해 설명한다. 인수와 반환 값, 예외 및 참고하는 곳의 지정 등 해당 Javadoc 태그와 값이 같이 지정된다.

Javadoc 옵션 지정

Javadoc 도구를 사용할 때에 몇 가지 옵션이 준비되어 있다. 여기에서는 각 옵션의 사용 방법에 대해 실제 예를 보면서 확인해 보겠다.

최종 수정 : 2024-01-18