[메이븐] 스프링 부트에서 Javadoc 사용하기

의존성 추가

메이븐(Maven)으로 의존성을 관리하는 환경의 스프링 부트에서 'Javadoc'을 사용하려면 'pom.xml' 파일의 'dependencies' 사이에 아래의 의존성을 추가한다.

<dependency>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <version>3.7.0</version>
</dependency>

플러그인 설정

 'pom.xml' 파일의 'plugins' 사이에 아래의 설정을 추가한다.

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <configuration>
        <stylesheetfile>openframework.css</stylesheetfile>
        <aggregate>true</aggregate>
        <minmemory>128m</minmemory>
        <maxmemory>256m</maxmemory>
        <breakiterator>true</breakiterator>
        <quiet>false</quiet>
        <source>1.6</source>
        <verbose>true</verbose>
        <linksource>true</linksource>					
        <outputDirectory>${project.build.directory}/classes/static/javadoc</outputDirectory>
        <reportOutputDirectory>${project.build.directory}/classes/static/javadoc</reportOutputDirectory>
        <destDir>/</destDir>					
        <locale>ko_KR</locale>
        <encoding>UTF-8</encoding>
        <charset>UTF-8</charset>
        <docencoding>UTF-8</docencoding>
    </configuration>
</plugin>

Javadoc 문서 생성

아래의 절차를 따라서 'Javadoc' 문서를 메이븐 빌드로 생성한다.

실행 설정

프로젝트 오른쪽 클릭 → Run As → Run Configurations... 클릭

설정 추가

Maven Build 오른쪽 클릭 → New Configuration 클릭

Javadoc 설정

위의 사진처럼 Javadoc을 설정하고 'Apply' 버튼과 'Run' 버튼을 차례로 클릭한다.

${workspace_loc:/프로젝트명}

javadoc:javadoc

콘솔 로그

콘솔 로그를 확인하여 문서가 잘 생성되는지 확인한다.

프로젝트경로/target/classes/static/javadoc

위의 경로로 이동하여 위의 사진처럼 문서가 생성되었는지 확인한다.

스프링 부트 실행

스프링부트를 실행하고 아래의 경로를 웹 브라우저에 입력하여 'Javadoc' 문서가 잘 나타나는지 확인한다.

http://아이피주소:포트번호/javadoc/index.html

Javadoc 문서가 잘 나타난 화면

참고문서

1. "Apache Maven Javadoc Plugin", MVN Repository. @원문보기