자바 javadoc으로 API 도큐먼트 생성하기

자바 주석

주석 종류	주석 처리 방식	설명
행 주석	// ~~~	//부터 행 끝까지 주석 처리
범위 주석 (block)	/* ~~~ */	/*과 */ 사이 블럭의 내용들을 모두 주석 처리
도큐먼트 주석	/** ~~~ */	/**과 */ 사이 블럭의 내용들을 모두 주석 처리 javadoc 명령어로 API 도큐먼트 생성 가능

 

Javadoc 이란?

소스 코드에 포함된 주석을 기반으로 HTML 문서(도큐먼트)를 생성하는 도구이다.

이를 통해 사용 방법과 설명을 문서화하여 다른 개발자들이 코드를 쉽게 이해할 수 있도록 도와준다.

 

Javadoc의 주요 태그들

/** */	주석의 시작과 끝
@param	메소드의 매개변수/인자값 설명
@return	메서드 반환값 설명
@throws	예외를 던질 경우 설명
@see	관련 항목 링크 제공

 

예시

주석을 통해 API 도큐먼트를 생성할 수 있다는게 와닿지 않아 직접 만들어보았다.

public class Test {

        /**
         * 
         * @param n1
         * @param n2
         * @return n1+n2
         */

        public int sum(int n1, int n2) {
            return n1 + n2;
        }
        
}

sum 메소드 위에 도큐먼트 주석을 작성했을때 자동완성된 부분이다.

자바 API 도큐먼트에 존재하는것 처럼 파라미터와 리턴값이 주석으로 명시된 것을 확인할 수 있다.

아래는 generate시에 만들어진 문서다.

 

주석에서 명시한 대로 도큐먼트가 잘 생성되는 것을 확인해봤다.