4. 프로그램 개발 문서

JavaDoc 문서화

JavaDoc

• JavaDoc은 소스 코드에 자동으로 문서화를 생성해주는 도구이다.
• JavaDoc은 소스 코드에 주석을 작성하면 HTML 형식의 문서를 생성해준다.
• JavaDoc 주석은 /**로 시작하고 */로 끝난다.

JavaDoc 주석 태그

JavaDoc 주석은 다음과 같은 태그를 사용할 수 있다.

태그	설명
@param	매개변수에 대한 설명
@return	반환 값에 대한 설명
@throws	예외에 대한 설명
@see	다른 문서에 대한 링크
@since	사용 가능한 버전
@version	버전
@deprecated	사용하지 않는 메서드나 클래스에 대한 설명

JavaDoc 주석 예시

/**
 * 이 클래스는 계산기 클래스입니다.
 */
public class Calculator {
    /**
     * 두 수를 더하는 메서드
     * @param a 첫 번째 수
     * @param b 두 번째 수
     * @return 두 수의 합
     */
    public int add(int a, int b) {
        return a + b;
    }
}

패키지에 대한 설명은 package-info.java 파일에 작성한다.

/**
 * 메일 관련 클래스를 포함하는 패키지
 */

package deu.cse.spring_webmail.mail;

JavaDoc 문서 생성

• JavaDoc 문서를 생성하기 위해 pom.xml에 다음과 같이 추가한다.

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <version>3.6.3</version>
    <configuration>
        <show>private</show>
    </configuration>
</plugin>

• JavaDoc 문서를 생성하려면 다음 명령어를 실행한다.

./mvnw javadoc:javadoc

• JavaDoc 문서는 target/site/apidocs 디렉토리에 생성된다.

JavaDoc 문서

JavaDoc 문서는 아래 링크에서 확인할 수 있다.

• JavaDoc 문서