PHpullh
학습 라이브러리/Java/자바독(Javadoc) 작성법

JAVA · 기초 문법

자바독(Javadoc) 작성법

Javadoc 주석으로 API 문서를 자동 생성하는 방법입니다.

기초 문법입문javadoc문서화주석API문서

핵심 설명

Javadoc 주석으로 API 문서를 자동 생성하는 방법입니다.

Java code

/**
 * 수학 유틸리티 클래스.
 * <p>다양한 수학 연산을 제공합니다.</p>
 *
 * @author 홍길동
 * @version 1.0
 * @since Java 21
 */
public class MathUtils {

    /**
     * 두 정수의 최대공약수를 구합니다.
     *
     * @param a 첫 번째 정수 (양수)
     * @param b 두 번째 정수 (양수)
     * @return a와 b의 최대공약수
     * @throws IllegalArgumentException a 또는 b가 음수인 경우
     * @see Math#max(int, int)
     */
    public static int gcd(int a, int b) {
        if (a < 0 || b < 0) {
            throw new IllegalArgumentException("음수 불가");
        }
        while (b != 0) {
            int temp = b;
            b = a % b;
            a = temp;
        }
        return a;
    }
}

학습 팁

javadoc -d docs src/*.java 명령으로 HTML 문서를 생성합니다. IDE에서는 /** 입력 후 Enter로 자동 템플릿이 생성됩니다.

주의할 점

@param의 파라미터명이 실제 메서드 시그니처와 다르면 경고가 발생합니다. 리팩토링 후 Javadoc도 함께 수정하세요.

자주 묻는 질문

자바독(Javadoc) 작성법란 무엇인가요?

Javadoc 주석으로 API 문서를 자동 생성하는 방법입니다.

자바독(Javadoc) 작성법 학습 시 주의할 점은 무엇인가요?

@param 의 파라미터명이 실제 메서드 시그니처와 다르면 경고가 발생합니다. 리팩토링 후 Javadoc도 함께 수정하세요.