JavaScript Angular 프로젝트에서 실행중인 JSDoc

Question

Angular CLI에서 빌드 한 Angular 4 프로젝트에서 작업하고 있습니다.

- npm install -g jsdoc 
- npm install --save-dev jsdoc 

그래서, 지금은 그것을 설치 :

다음 나는 JSDOC

내가했던이 다음과 같은 지침을 설치하려고합니다.

내 질문은 ... 다음에 doc 파일을 생성하려면 어떻게해야합니까?

jsdoc의 yourJavaScriptFile.js

는 "yourJavascriptFile.js"무엇을 의미 하는가 :

이이 명령을 실행하려면 문서를 말한다? 나는 typescript를 사용하는 Angular를 사용하고 있습니다 ... 그리고 모든 타이프 스크립트 파일을 주석으로 스캔 한 다음 문서를 생성해서는 안됩니까?

공식 문서에는 이에 대한 내용이 없으므로 혼란 스럽습니다.

누구에게 도움을 줄 수 있습니까? 당신은 기본적으로 타이프 라이터를 쓰고있어 이후

Answer 1

당신은 실제로 각도 프로젝트에 JSDOC을 사용할 수 없습니다 그러나는 typedoc 및 compodoc처럼 JSDOC 형식 구문의 일부를 지원 JSDOC 다른 대안이, 후자는 주로,있다 각도 프로젝트에 중점을 둡니다.