webstorm jsdoc-toolkit 지정하는 법

webstorm에서 jsdoc-toolkit 설정하는 법.

구글에서 검색하면 이것저것 나온다.....

헌데 좀 헷갈리는것들이 있다.

차근차근 조낸 삽집하다보면 잘 된다....ㅋ

1. jsdoc-toolkit 다운 --> https://code.google.com/p/jsdoc-toolkit/   ( java 설치도 되어 있어야한다 )

2. 웹스톰을 연다. 그리고 File > Settings > External Tools >Add(우측에 + 표시 아이콘을 지칭)

   - 참고로 아래 javascript와 jsdoe-tookit이 이미 보이는데 이건 머 내가 추가해놨기에 보이는 거임....

3. 그럼 아래 화면과 같은 설정창이 나온다.

맨처음 

Name - 무슨 놈인지 이름을 지정.

Group - 웹스톰 상단에 여러 메뉴들이 있는 그 중 Tool 이란 카테고리에 추가된다.

         거기서 그룹지정하는 메뉴이름을 지칭한다. 

          걍 나는 javascript라고 평범하게 지어봤다. 

         name과 Group을 지정했다면 아마 아래 그림처럼 상단Tool 에 지정한대로 메뉴가 추가가 되었을 것이다.

         나같은 경우는 javascript > jsdoc-toolkit 이라고 지정이 되어 있다.

options : 음 이부분은 걍 알아서.....

Tool settings : 이부분이 가장 중요하다.

- Program: 현재 자신의 컴퓨터에 java가 설치된 경로를 지칭한다. 나같은 경우는 위 이미지에 나온대로의 경로에 java가 설치되어 있다.

- Parameters : 이건 ....이건 진짜 별거 아닌데 하루 종일 헤맨거 같다..... 무튼 jsdoc-toolkit을 실행시키는 명령어다. 

                 웹스톰에서 실행시킬수 있는 매크로 설정 부분만 빼면 걍 command line에서 저 코드를 실행해도 된다.

- working diretory: jsdoc-toolkit 이 배치 된 경로이다.

자 그럼 이제 부가 설명 들어간다.

도스창 즉 command line 에서 jsdoc-toolkit을 실행 시킨다면 아래와 같다.

java.exe -jar jsrun.jar app/run.js  \work\pub\ui.js -t=templates/jsdoc -d="/work/pub/libs"

                 

우선적으로 커맨드에서 실행할때 jsdoc-toolkit 을 배치해둔 곳으로 루트 설정하고 한다. 

머 내경우는 e:\jsdoc-toolkit 으로 루트 설정하고 진행했다.

 java.exe -jar jsrun.jar app/run.js  이부분은 걍 머 알고 싶지 않으면 걍 그대로 보고 타이핑 치면 된다.

중요한건 \work\pub\ui.js 부분과 -d="/work/pub/libs" 두 군데이다.

\work\pub\ui.js 부분은 보는데로 문서화할 js 파일 경로 설정이다. 

-d="/work/pub/libs"  부분은 문서화가 된 파일들이 배치될 경로이다.

저 두군데만 잘 설정해서 입력하면 도스창만으로 실행 가능하다.

자그럼 웹스톰에 적용하는건 Tool settings부분만 잘 설정하면 게임 끝이다.

커맨드 라인 입력 코드 첫번째가 java.exe 였다.

1. Program 

 - 내컴퓨터에  java.exe 가 있는 경로를 설정.( 그림 참조 )

2. Parameters

   -jar jsrun.jar app\run.js -v -r "$FilePrompt$" -t=templates\jsdoc -d="$FileDir$" 

   위의 커맨드 라인에서 입력한 익숙한 것들이 있다.

   여튼 중요한건 "$FilePrompt$"  이부분 이건 위 그림에 보면 insert macro라고 있다. 

    그버튼 클릭하면 매크로들이 나온다. 즉 해당 매크로는 문서화할 js 파일 선택 프롬프트 띄우기 라고 생각하면 된다.

   마지막으로 -d="$FileDir$" 부분 > 문서화된 파일들의 아웃풋 경로설정이다.

   내경우 -d=" " 라고 입력후 콤마사이에 매크로를 때려넣은거다. 

   $FileDir$ 매크로는 현재 프로젝트에서 열려 있는 폴더에 해당 문서화파일들을 배치한다는 말이다.

3. working diretory

   jsdoc-toolkit 이 배치 된 경로이다.

아 암튼 설정하고 나면 별거 아닌데....이걸로 하루종일 헤매다니.....오늘의 멘붕 여기서 끝....