2.7.8 주석 내보내기

이 절에서 설명하는 docDirectory는 HTML 파일을 내보낼 디렉터리 이름을 나타낸다. HTML 파일을 내보낼 때는 다음 단계를 따른다.

1. 문서화하려는 소스 파일이 있는 디렉터리로 이동한다. com.horstmann.corejava처럼 문서화하려는 패키지가 중첩되어 있을 때는 com을 서브디렉터리로 포함하는 디렉터리(개요 주석을 제공할 때는 overview.html 파일이 있는 디렉터리)에서 작업해야 한다.

2. 다음 명령을 실행한다.

$ javadoc -d docDirectory package1 package2 ...

-d docDirectory 옵션을 생략하면 HTML 파일이 현재 디렉터리에 추출된다. 그러면 디렉터리가 지저분하므로 권장하지 않는다.

수많은 명령줄 옵션으로 javadoc 프로그램을 세세하게 조정할 수 있다. 예를 들어 -author와 -version 옵션을 사용하면 @author와 @version 태그를 넣을 수 있다(이 옵션들은 기본 생략되어 있다).

표준 클래스에 하이퍼링크를 넣는 -link 옵션도 유용하다. 예를 들어 다음 명령을 실행하면 모든 표준 라이브러리 클래스가 자동으로 오라클 웹 사이트에 있는 문서로 연결된다.

$ javadoc -link http://docs.oracle.com/javase/9/docs/api *.java

-linksource 옵션을 사용하면 각 소스 파일을 HTML로 변환하고, 클래스와 메서드 이름이 소스를 가리키는 하이퍼링크로 바뀐다.