Java Script

JsDoc 설치 및 Eclipse 연동 (java script API 문서 지원툴)

스마트큐브 2012. 3. 3. 18:01

1. http://code.google.com/p/jsdoc-toolkit/ 여기에서 다운 
  (난 jsdoc_toolkit-2.4.0.zip 다운 )



2. 적당한 곳에 압축풀기 
  (난 C:\jsdoc_toolkit 에 해제)

3. 이클립스 설정 
 메뉴 이동 ( Run -> External Tools -> External Tools Configurations..)


* 참고 : project_loc 는 이클립스에서 지원해주는 변수로서 프로젝트 폴더의 절대 경로를 반환 해준다.
(난 web/script 에 있는 *.js 파일들을  프로젝트\jsdoc 에 문서가 만들어지도록 설정 ) 

4. 실행 
test.js 파일을 에 대해
/**
 * Create an new XeLib instance
 * @class XeLib
 *
 */
function XeLib(){
 
}
실행 결과는 다음과 같다



* 키워드 참조 :   http://code.google.com/p/jsdoc-toolkit/w/list 

* 중요 tag
@param
@return
@see
@link
@class
@constructor(JSDoc전용)
@type
@extends