자바스크립트 문서화를 위한 "jsdoc toolkit" 사용법 및 예제

Javascript 2012. 8. 27. 16:12

자바스크립트 문서화를 위한 "jsdoc toolkit" 사용법 및 예제

1. jsdoc tookit-2.4.0.zip(현재 버전 기준)을 다운받아 적당한 위치에 압축을 해제한다.

2. jsdoc toolkit 실행

- Mac OS 기준:

터미널 접근 후 해당 폴더(jsdoc tookit 루트 폴더)에 위치하여 아래 명령어를 실행한다.

java -jar jsrun.jar app/run.js javascript_doc_test.js(jsdoc을 활용해 변환시킬 *.js 파일) -t=templates/jsdoc -d="out"(이와 같이 디렉토리를 지정(-d="out")하면 현재 위치(jsdoc 루트 폴더)에 ".out" 폴더가 생성되며, 그 아래 index.html(root file), symbols(하위 file을 포함하는 디렉토리)가 추가적으로 생성된다.

- Window OS 기준:

아래 링크를 참고해 "java"를 다운받아 설치한 후 OS 환경변수를 설정한다.

- 자바(java) 설치 및 환경변수 설정...

http://caskers.tistory.com/372

윈도우 명령프롬프트(커멘드창) 접근 후 해당 폴더(jsdoc tookit 루트 폴더)에 위치하여 아래 명령어를 실행한다.

java.exe -jar jsrun.jar app/run.js javascript_doc_test.js -t=templates/jsdoc -d="out"

3. jsdoc toolkit 작성법

@namespace: 네임스페이스 설명(javascript를 이용한 MVC Pattern 구현)
@author: 작성자(<a href="http://mohwaproject.tistory.com">mohwa</a>)
@version: 버전(0.1)
@since: 작성일(2012.08.)
@see: 참조 문서 및 메서드
@description: 상세 설명

@class: 클래스 설명(MVC Data Model 중 하나로 등록된 각 데이터 모델(Object)을 갱신 및 mvc.Entities.cookie 클래스를 통해 유지 시킨다.)
@constructor 함수가 생성자일 경우만 표기(Entities Class 생성자 함수)
@param 해당 매개변수({String} memberName 등록된 Entities 객체 구분 key(mvc.Entities[key] 암묵적 전역 변수에 객체(this)가 선언 및 정의한다.))
@type 리턴 데이터 타입(Object)
@returns 리턴값(해당 context)
@example 예제코드(mvc.Entities('board');)