JavaScript의 문서화작업을 위해
JsDoc Toolkit 을 이용하였습니다. (*참조:
sourceforge 내 프로젝트)
API를 만들기위해 JavaScript의 문서화 규칙을 위해
Tag Reference를 이용한 주석을 사용하여야 합니다.
JSDoc는 Perl 로 제작된 오픈소스 입니다.
JSDoc를 사용하기 위해 다음과정을 통해 환경을 구축하여야합니다.
1. ActivePerl 다운로드&설치
2. PPM(Perl Package Manager)를 실행하여, "HTML-Template" Perl module를 설치한다.
3. JSDoc를 다운받는다.
* WINDOWS 환경에서 설치 실행하였습니다.
1. ActivePerl 다운로드&설치
다운로드URL :
http://www.activeperl.com/Products/Download/Download.plex?id=ActivePerl
"ActivePerl-5.10.0.1004-MSWin32-x86-287188.msi" 을 다운 받아 설치하였습니다.
2. PPM(Perl Package Manager)를 실행하여, "HTML-Template" Perl module를 설치한다.
a.CMD에서 PPM을 실행하면 아래와 같은 Perl Package Manager가 뜬다.
b. Edit 아래의 버튼을 클릭하면 현재 설치할수 있는 Perl Package들의 목록이 나온다.
c. Help 아래의 검색화면에 Html-template를 타이핑하면 아래와같이 하나의 패키지가 나옵니다.
d. 검색창 오른쪽 옆의 노란박스에 녹색+ 버튼을 클릭하여 install 목록에 추가합니다.
e. 추가된 install 목록을 설치하기 위해 녹색화살표 버튼을 클릭합니다.
f. 설치가 완료되면 아래 활성화된 패키지가 목록에 추가되어지며 설치가 완료됩니다.
3. JSDoc를 다운받는다.
다운로드URL:
http://sourceforge.net/projects/jsdoc
현재 받은 버전은 jsdoc-1.10.2 버전입니다.
압축을 풉니다.
저는 "D:\JSDoc-1.10.2" 디렉토리에 압축을 풀었습니다.
문서를 작성하여 보겠습니다.
아래는 String 객체에 약간 확장한 String.Extend.js 파일입니다.
|
//////////////////////////////////////////////////////////////////////////////
/**
* String Object를 확장한다.
*/
//////////////////////////////////////////////////////////////////////////////
/**
* 이 스트링의 양단으로부터 공백을 제거합니다.
* @returns {String} 공백이 제거된 문자
* @author seokjune.hong(2008.10.21)
*/
String.prototype.trim = function() {
return this.replace(/(^\s*)|(\s*$)/gi, "");
}
/**
* 이 스트링의 좌측으로부터 공백을 제거합니다.
* @returns {String} 공백이 제거된 문자
* @author seokjune.hong(2008.10.21)
*/
String.prototype.ltrim = function() {
return this.replace(/^\s+/,"");
}
/**
* 이 스트링의 우측으로부터 공백을 제거합니다.
* @returns {String} 공백이 제거된 문자
* @author seokjune.hong(2008.10.21)
*/
String.prototype.rtrim = function() {
return this.replace(/\s+$/,"");
}
/**
* 이 스트링이, 지정된 접두사로 시작될지 어떨지를 판정 합니다.
* @param {String} txt 접두사
* @returns {boolean} 지정된 접두사로 시작되면 true, 아니면 false
* @author seokjune.hong(2008.10.21)
*/
String.prototype.startsWith = function(txt) {
var strTxt = this.substring(0,txt.length);
return (txt == strTxt)
} |
Perl 명령을 사용하여 JSDoc를 아래와같이 실행한다.
실행한 결과 입니다.
