Simple usage of javadoc (javadoc 로 문서 만들기)

Java 프로그래머라면 누구나 알고 있어야 할 사실이 있다.

바로 문서!!!

JDK 에서는 문서 생성 프로그램을 제공하며, 프로그램의 이름은 javadoc 이다.

이 프로그램을 이용하면 Java 소스에 작성된 javadoc 를 이용하여 문서를 만들 수 있다.

문서를 만드는 방법은 매우 간단하다.

필요에 따라 여러가지 옵션을 이용할 수 있으나, 너무나도 다양한 옵션들이 존재하기 때문에, 더 자세한 정보를 얻기 원한다면 javadoc help 를 이용하면 되겠다.

내가 작성한 소스의 디렉토리구조가 아래와 같다고 하면,

/src/com/Common.java

/src/com/*.java <- 많은 파일들이 위치

/src/com/naver/A.java

/src/com/daum/B.java

/src/com/daum/*.java

이럴 경우 javadoc를 생성하기 위해서는 -subpackages 라는 옵션과 package 이름을 주면 된다.

com 밑의 모든 패키지에 대해서 문서를 만들기 위해서 아래와 같은 명령어를 사용하였다.

$ cd /src

$ javadoc -d /home/john/doc/ -subpackages com

여기서 -d 옵션은 문서를 생성하여 결과물이 저장될 디렉토리를 의미한다.

결과물은 /home/john/doc 밑에 생성이 된다.