jsdoc3 maven plugin 사용법

jsdoc 을 이용하면 javadoc 과 같이 javascript 파일에 대한 api 를 자동으로 생성할 수 있다. 물론 jsdoc 생성과 관련한 주석에 대한 규칙을 알아야 하지만 이번에는 jsdoc3와 maven 의 연동에 대해서만 짧게 작성하려 한다.

우선 사용한 jsdoc3-maven-plugin 은 여기에 잘 설명되어 있다. 그중 내가 사용한 부분의 코드는 다음과 같다.

<dependency>

<groupId>com.github.phasebash</groupId>

<artifactId>jsdoc3-maven-plugin</artifactId>

<version>1.0.7</version>

</dependency>

<build>

    <plugins>

        <plugin>

            <groupId>com.github.phasebash</groupId>

            <artifactId>jsdoc3-maven-plugin</artifactId>

            <version>1.0.7</version>

            <configuration>

                <recursive>true</recursive>

                <directoryRoots>

                    <directoryRoot>${basedir}/src/main/webapp/resources/js</directoryRoot>

                    <directoryRoot>${basedir}/src/main/javascript</directoryRoot>

                </directoryRoots>

            </configuration>

        </plugin>

    </plugins>

</build>

Run the Mojo.

mvn clean jsdoc3:jsdoc3

버전에 따라 실행이 안될 수 있으니 참고하길 바란다. 

참고

https://github.com/phasebash/jsdoc3-maven-plugin