[Eclipse] eclipse에서 Javadoc을 만들어봅시당.

원글 : http://ojava.tistory.com/category/Program/JAVA 

java API를 이용해 보신적이 있으시다면 API를 어떻게 만드는지 궁금하신 분이 있으시겠죠!

아니면 개발한 내용에 대해서 내용 이해를 위해 javadoc을 배포해야 할 일이 있다면

여기 간단하게 만드는 방법이 있습니당.

 

eclipse에서 제공하는 javadoc 이용방법을 소개합니다.

  

 

1)       javadoc으로 만들기를 원하는 프로젝트 또는 내용이 담긴 폴더에 오른쪽 클릭을 합니다.

그 중, 밖으로 내보내는 기능을 하는 Export 메뉴를 클릭합니다.

 

2)       Java 폴더의 Javadoc이라는 내용을 클릭하고 다음 단계로 이동합니다.

 

  

 

3)       또는 1과 2단계를 한번에 처리하고 싶으시다면~ 더욱 간단하게

상단메뉴의 Project > Generate Javadoc을 누르면 앞의 두 단계를 생략합니다~

 

  

 

4)       Javadoc을 만들기 위해서 입력해줘야 하는 기본정보입니다.

1.      Javadoc command : javadoc을 만들어주는 기능을 하는 javadoc.exe 파일의 경로를

입력하는 부분입니다. configure에서 자신의 jdk가 있는 경로를 찾아서 javadoc 파일을 선택해주시면 됩니다. 

하지만 기본적으로 경로가 입력되어서 나온답니당~

2.      파일 구조가 트리구조로 보이는 부분은 javadoc으로 만들고자 하는 내용을 선택합니다.

3.      Use standard doclet : javadoc이 만들어지는 경로를 선택해주시면 됩니다.

Javadoc은 일반적으로 폴더 및 여러 파일로 구성되므로 원하는 경로에 빈 파일을 만들어 주시면 깔끔하게 보입니다.

5)   필요한 내용이 없으시다면, 딱히 선택하지 않으셔도 됩니다.

자 이제 완성입니다~ Finish를 누르면 밑의 Console으로 JavaDoc이 만들어지는 내용이 좌르륵~ 뜨게 됩니다.

그 중에 뜨는 Warning 부분만 잘 잡아주시면 깔끔한 javadoc을 만드실 수 있습니다.