Javadoc 사용하기

javadoc은 java를 공부하다보면 한번씩 봤을 법한 html 형식의 표준 문서를 생성하는 도구 이다.

사용법은 아래와 같다.

우선 코드를 작성 할때 함수 앞에 아래와 같이 주석문을 작성한다.

/**
* 어떤 어떤 역할을 하는 함수 이다.
* @param 입력변수
* @return 리턴 값
* @see 다른 코드 참고
*/
public String getReturn(int a, int b){
        return result;
}

그리고 커맨드 창에서 javadoc 명령어를 아래와 같이 실행한다.

javadoc [-option] 패키지 또는 java 파일 명

eg. javadoc -sourcepath /java/jh/com -d /java/doc test.java

option 종류는 아래와 같다.

-sourcepath 소스 파일 경로

-d 생성된 문서 위치

-overview 개요문으로 사용할 파일

-doctitle 문서 제목

-header 머리글

-bottom 바닥글

-use "Use" 파일 추가