[Java] Javadoc 활용한 자바 주석 처리

JavaDoc란?

Javadoc은 자바 코드에 대한 문서를 생성하는 도구입니다. 주석을 통해 코드의 기능, 매개변수, 반환 값 등을 설명하고, 이를 HTML 형식의 문서로 만들어줍니다. 컴파일시 모든 주석은 지워지므로 프로그램 성능에는 전혀 영향이 없습니다.

참고로, IDE Tool에서 /** Enter를 치면 해당 JavaDoc를 바로 쓸 수 있습니다.

 

JavaDoc Tags

	Description	Example
@version	구현체(클래스, 메소드,변수 등)의 버전
@author	작성자
@deprecated	해당 구현체가 곧 삭제, 업데이트 중단을 의미
@since	해당 구현체가 추가된 버전
@see	외부 링크나 텍스트, 다른 필드나 메소드를 링크할 때 사용	외부 링크 : a href 태그 이용 내부 참조 : 패키지명#생성자/ 필드 / 메소드명
@link	see와 동일한 기능, 참조에 대한 링크 제공
@exception	발생할 수 있는 Exception 정의
@throws	코드에서 throw 할 수 있는 예외상황 정의
@param	메소드의 매개변수 / 인자값 설명
@return	반환값
@serial	Serializable Interface에 사용
@serialDate	writeObject writeExternal 메소드로 작성된 추가적 데이터를 설명
@serialField	serialPersistnetFields 배열의 모든 필드에 사용

 

JavaDoc Tag를 이용한 예제

/**
 * 계산기 클래스입니다.
 * 
 * @author 홍길동
 * @version 1.0
 */
public class Calculator {
    /**
     * 두 수를 더하는 메소드입니다.
     *
     * @param a 첫 번째 숫자
     * @param b 두 번째 숫자
     * @return 두 수의 합
     */
    public int add(int a, int b) {
        return a + b;
    }

    /**
     * 두 수를 나누는 메소드입니다.
     *
     * <pre>
     * int result = divide(100, 5);
     * System.out.println(result); // 20
     * </pre>
     *
     * @param a 첫 번째 숫자
     * @param b 두 번째 숫자
     * @return 두 수의 나눗셈 결과
     * @throws ArithmeticException 두 번째 숫자가 0일 경우 발생
     */
    public int divide(int a, int b) throws ArithmeticException {
        if (b == 0) {
            throw new ArithmeticException("0으로 나눌 수 없습니다.");
        }
        return a / b;
    }

}