eclipse 자바독 API 만들기

1) API(Application Programming Interface)란?

: 자바를 사용하여 쉽게 구현할 수 있도록 한 클래스 라이브러리의 집합. 

즉 자바라는 언어를 사용하여 사용자의 부담을 최소화 하는 반면에 입출력, 화면구성, 이미지, 네트워크와 같이 복잡하지만 필요한 클래스들을 미리 구현하여 사용자가 쉽게 구현하도록 하는 API이다. 

이러한 자바 API는 하나의 커다락 플래스 계층구조로 설계되어 있다.

[출처] 자바 API 란|작성자 빵끄

무슨 말인지 잘 모르겠다.

http://docs.oracle.com/javase/6/docs/api/

이 곳을 들어가면 java se버전의 모든 메소드를 모아놨다.

한마디로 영어 사전 같은 곳이다. 소스를 코딩하기 전 잘 알지 못하는 메소드를 찾아 그에 대한 정의를 보고 사용법을 익히는 것이다.

예를 들어 String 클래스의 indexOf 메소드를 찾아보자.

왼쪽 위에서 java.lang을 클릭하면 java.lang에 해당하는 interfaces, Classes, Exceptions 등의 분류로 여러 메소드가 뜬다.

String 클래스를 클릭하면 String 클래스에 해당하는 메소드들을 집합시켜놨다.

거기서 indexOf를 클릭하자.

indexOf

public int indexOf(String str,int fromIndex)

  Returns the index within this string of the first occurrence of the specified substrng. starting at the specified index. The integer returned is the smallest value k for which:
k >= math.min(fromIndex, this.length()) && this.startsWith(str, k)
If no such value of k exists, then -1 is returned.
Parameters:
str - the substring for which to search.
fromIndex - the index from which to start the search.
Returns:
the index within this string of the first occurrence of the specified substring, starting at the specified index.

이렇게 나온다. indexOf의 정의, 어떤 식으로 값이 반환되는지, 파라미터는 무엇인지, 리턴값은 무엇인지에 대해 나오게 된다.
메소드에 대한 주어지는 API 말고도 자신의 소스에 주석을 달아서 API를 만들 수 있다.

2) API 만들기
  1. 자신이 자바독을 만들고 싶은 프로젝트를 오른쪽 클릭.
  2. Export를 클릭, Export창에서 Java>JavaDoc을 클릭.
  3. JavaDoc Command에는 자신의 컴퓨터에 설치되어있는 jdk 안의 bin>JavaDoc.exe 경로를 잡아줌.
  4. Destination에는 저장할 공간 선택
  5. 다음을 누른 뒤 Document로 만들 수많은 jar 파일과 프로젝트가 나옴.
  6. 선택을 한 뒤 완료.

3) API 문서의 내용
나 같은 경우는 이전 글의 주석을 달았던 소스파일로 API 문서를 만들어 보았다.

StringControl.html
내가 작성했던 이름이 Author로 나오고,
메소드는 메인메소드만 사용했기때문에 main 메소드만 뜬다.

하지만 정말 많은 변수와 많은 메소드를 가지고 있는 소스에서 API를 만들어 본다면 자신의 개략적인 도면이 나올 것이다.