안녕하세요. 소심비형입니다. 오늘은 이클립스를 이용하여 자바독 주석을 문서화하는 방법에 대해서 알아보도록 하겠습니다. 여러가지 툴들이 있지만, Doxygen이나 Docbook 보다는 자바독을 많이 사용하고 있죠. Doxygen은 홈페이지 상단 우측에 돋보기에서 검색해보면 관련 내용을 찾을 수 있습니다.

 

먼저 문서화할 클래스에 자바독 주석을 추가합니다.

 

 

패키지 또는 클래스 파일에서 우 클릭 > Export...를 선택하세요.

 

 

Export창에서 Java > Javadoc을 선택하고 Next를 클릭하세요.

 

 

기본 설정으로 놔두고 Next를 클릭하세요. 만약, 주석에 한글이 없다면 바로 Finish를 클릭하여 마법사를 완료해되 됩니다. 한글이 포함되어 있다면 인코딩을 변경해야 하기에 Next로 이동하세요.

 

 

기본 설정으로 놔두고 Next를 클릭하세요.

 

 

주석에 한글이 포함되어 있다면 VM options에 아래와 같이 추가하고 Finish를 클릭하여 마법사를 완료합니다.

-locale ko_KR -encoding UTF-8 -charset UTF-8 -docencoding UTF-8

 

 

아래와 같이 물리적인 doc폴더가 생성되고 각종 파일들이 생성됩니다. 이곳에 보면 문서화된 클래스도 생성되어 있습니다. RalationalOperator.html에서 우 클릭 > Open With > Web Browser를 선택하세요.

 

 

이렇게 간단하게 자바독을 이용하여 문서화하는 방법을 알아보았습니다.

 

 

다음 시간에...

추천0 비추천0