jsdoc을 이용한 자바스크립트 문서화

[황정식]

: 프로젝트를 진행하다가 자바스크립트 객체를 javadoc과 같이 문서화를 할 필요성이 생겼다. 다행히 jsdoc이라는 툴킷이 있어서 테스트를 해보았는데 잘 되는거 같다. 이참에 사용방법을 정리해본다.

1. 아래 사이트에서 jsdoc-toolkit을 다운로드 한다.

: https://code.google.com/p/jsdoc-toolkit/

2. 다운로드 받은 압축 파일을 적절한곳에서 압축 해제한다.

3. 이클립스를 열고, 상단의 메뉴에서 Run > External Tools > External Tools Configurations를 선택한다.

4. 좌측의 "Program" 아이콘에서 마우스 오른쪽 버튼을 누른 후, New를 선택한다.

5. 아래와 같이 자바 실행 파일과 jsdoc 압축 해제 디렉토리, Arguments 설정을 한다.

Arugments를 잠깐 살펴보면,

-jar jsrun.jar app\run.js -a -t=templates\jsdoc ${project_loc}\WebContent\siksco\*.js -d=${project_loc}\WebContent\jsdoc

--> 노란색 부분은 문서로 만들 js 파일이 위치한 경로를 나타낸다.

--> 분홍색 부분은 만들어진 문서가 생성되는 경로이다. 

--> 여기서는 ${project_loc} 변수를 이용해서 현재 프로젝트내에 저장을 했지만 외부 디렉토리에 저장을 해도 된다.

"Run"을 눌러서 실행을 하면 아래와 같이 jsdoc 문서가 html 파일로 생성이 된다.