[펌]이클립스에서 JAVADOC 만들기

[이클립스에서 JAVADOC 만들기]

 

이클립스에서 Javadoc을 만들기 위한 방법을 소개한다.

 

 

1. Package Excplorer에서 Javadoc을 추출해 내기 위한 구간을 설정한다.

전체를 대상으로 하기 위해서는 src로 설정하면 된다.

 

 

2. Package Explorer에서 정한 src에서 Export로 들어가면 위와 같은 화면이 나오고, Java > Javadoc을 선택하고 Next 하자.

 

 

3. 본격적으로 Javadoc 생성을 시작해보자.

위 그림에서 Javadoc Command는 실질적으로 Javadoc생성을 위한 실행파일을 지정하는 곳이다.

JDK가 정상 작동 중이면 자동 설정될 것이다. 문제가 있다면 Configure를 눌러 재설정 후, 계속하면 된다.

 

Select types for which Javadoc will be generated :

자바독에서 생성할 대상을 선택하라 :

 

좌측 리스트 박스에서는 패키지를 선택할 수 있으며, 우측 리스트 박스에는 좌측 에서 선택한 패키지에 해당하는 클래스들이 나열된다.

패키지 선택은 물론, 클래스 선택도 가능하다.

 

출력시 자바 패키지의 대상들을 별도로 유형별로 선택할 수 있는데, 전체를 출력하고 싶다면 Public으로 하면 된다.

 

Use Standard Doclet은 자바독이 생성될 위치를 설정하는 것이다. 보통은 이클립스 프로젝트 밑에 doc이라는 폴더가 생성되게 마련인데, 여기서는 SVN에 올릴 것이 아니어서 임의의 임치를 지정했다. 이 경우, 다음 단계에서 이 위치를 default doclet으로 설정할 것인지에 대해 묻는 메세지 다이얼로그가 나온다. 자세한 설명은 그때하겠다.

 

 

4. 다음으로 페이지에 대한 약간의 옵션을 설정해야 한다.

Basic Options는 전체적인 레이아웃 및 기능에 대한 옵션이다.

Document these tags는 주석에 관한 내용이다. 옵션 체크된 항목은 소스로부터 가져오려 할 것이며, 정상적으로 주석이 기록되어 있지 않다면, Javadoc 생성시 Console창에서 warning으로 표시되므로 주의하자.

 

Select referenced archieves and projects to which links should be generated :

생성시 링크할 참조 라이브러리나 프로젝트를 선택하라.

 

해당 프로젝트에 속해 있는 라이브러리(보통 jar파일) 혹은 다른 프로젝트를 Javadoc 생성 범주에 놓을 것인가를 선택할 수 있다.

해당 라이브러리가 Javadoc을 지원하지 않는('Javadoc 생성을 목적으로 주석을 정리한'과 동일한 의미) 라이브러리라면 선택하지 않는 것이 현명하다.

 

Style Sheet는 자바독에 적용할 Style Sheet를 정하는 곳이다. 필요하면 설정하도록 한다.

 

 

5. javadoc.exe 파일에서 부여할 수 있는 옵션을 설정할 수 있다.

자세한 설정 방법은 javadoc.exe -help를 이용하자.

 

여기서 알아보고자 하는 중요한 점은 어떻게 하면 "한글 깨짐"을 방지할 것인가이다.

자바 소스를 UTF-8로 생성하지 않으면 자바독 생성시 한글이 깨져나오는 현상을 볼 수 있다.

이를 막고자 몇가지 옵션을 줘야하는데 그 옵션은 위 그림에서 볼 수 있다.

 

보통 해당 옵션들은

 

javadoc.exe -locale ko_KR -encoding UTF-8 -charset UTF-8 -docencoding UTF-8

 

로 실행되는데, 옵션을 위 그림과 같이 배치하면 된다.

 

하단의 나머지 옵션은 직접 해석보면 쉽게 무슨 말인지 알 수 있다.

 

* Doclet 위치에 대해서...

Docklet 위치를 자바독 위자드에서 미리 설정되어 있는 Doclet 위치가 아닌 다른 곳으로 위치를 설정하면 다음과 같은 메세지 다이얼로그를 생성 전에 볼 수 있다.

 

 

즉, 새로 지정한 위치를 Javadoc loaction으로 지정할 것인지에 대해 묻는 것이다. 본래는 설정된 위치가 있는데 사용자가 임의로 그 위치를 조정하니 디폴트도 변경할 것인가 물어보는 것이다. 디폴트 위치를 변경할 것이면 Yes To All 하면 되고, 아니면 No To All 하면 된다. 필자는 임의의 위치로 변경했고, 앞으로 프로젝트 안에 자바독을 생성할 것이므로 No를 선택했다.

[출처] 이클립스에서 JAVADOC 만들기|작성자 데브킨