javadoc 만드는 방법

코딩을 하다보면 각자의 Util클래스를 만들고 쓸 경우가 많습니다.

 

그런데 Util클래스를 점점 늘리다 보면 만들었었는지 아니면 어떻게 쓰는건지 잊어먹을 때가 있습니다.

 

그래서 java는 javadoc 이라는 것을 이용해서 java api reference 처럼 document를 만들 수 있습니다.

 

저는 이클립스에서 document 만드는 방법을 해보겠습니다.

 

시작하기에 앞서 모든 메소드나 변수에 주석이 작성되어 있어야합니다. 그렇지 않을 경우엔 설명이 없는 document가 되겠죠?

 

주석은 보통 각 변수나 메소드 위에서 /** 엔터 치면 생기는 리턴타입, 파라미터타입 등을 적어주시면 됩니다.

 

제가 만들 자바파일은 StringUtil.java 이고 인코딩 타입은 UTF-8로 진행하겠습니다.

 

인코딩 타입이 안맞으면 한글이 깨지거나 document가 만들어지지 않을 수 있으니 파일의 인코딩 타입을 정확히 알고 진행하세요

 

프로젝트 전체를 하는 방법도 똑같기에 따로 설명은 하지 않고, 자바파일 하나만 하겠습니다.

자바파일 오른쪽 클릭 -> Export 선택

javadoc 검색해서 선택

javadoc command : 자바 설치 폴더\bin\javadoc.exe 선택

Use standard doclet : document 파일 생성할 폴더 위치

Next

Basic Options 에서 설정해주시고 Next

여기서 encoding과 charset을 설정해주어야 합니다.

전 둘다 UTF-8로 했습니다. (자바파일의 맞게 설정해주세요)

옵션 홈페이지 참조 : http://download.java.net/jdk7u8/docs/technotes/tools/solaris/javadoc.html#charset

JRE source compatibility : 1.6이 기본이었는데 1.7로 변경했습니다.

Finish

위에서 설정한 Use standard doclet 폴더 위치에 가보면 파일과 폴더가 여러개 보일겁니다.

index.html 파일을 열어봅니다.

짜잔~ java reference와 같이 custom document가 생성되었습니다.

파일과 메소드들이 많다면 만들어 놓고 어떤 것들이 있는지 찾기 쉬울 것 같습니다.