Javadoc 만들기 | Javadoc 기본 | Javadoc으로 생성된 문서


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

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

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

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

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

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

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