[Javadoc] Javadoc으로 생성된 문서

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

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

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

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

Javadoc 기본

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

Javadoc으로 생성된 문서

먼저 Javadoc의 사용법을 살펴 보기 전에 실제로 Javadoc로 생성된 문서의 예제를 살펴 보도록 하자.

JDK의 API 설명 페이지를 보도록 하자. (로컬 또는 온라인이든 상관 없다).

https://docs.oracle.com/javase/8/docs/api/

아래 명세서는 Boolean 클래스에 대한 내용이다. 

이 API 설명 페이지에 표시되고 있는 이 HTML 페이지가 Javadoc로 생성된 문서이다. 이 문서는 Java 소스 코드에 작성된 코멘트에서 Javadoc을 사용하여 생성되었다.

이와 동일하게 자신의 소스 코드도 Javadoc에 따른 형식으로 주석을 작성하도록 해두면, 나중에 생성한 클래스 등에 관한 문서를 만들 수 있게 된다. 또한, Javadoc에 따른 형식으로 작성해 두면 일반적인 주석으로 읽을 수 있을 정도로 아무런 위화감도 없는 쉽고 간단한 형식으로 되어 있다.

다음 페이지에서는 간단한 코멘트를 작성하는 방법을 보도록 하자.