在Angular項目上運行的JavaScript JSDoc

Question

我正在使用Angular CLI構建的Angular 4項目。

接下來，我想安裝JSDOC

我這樣做如下說明：

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

所以，現在我把它安裝。

我的問題是......我下一步要做什麼來生成doc文件？

它說，在文檔中運行此命令：

jsdoc yourJavaScriptFile.js

是什麼意思與 「yourJavascriptFile.js」？我正在使用Angular，它使用打字稿...並且不應該掃描我的所有打字稿文件以進行評論，然後生成文檔？

官方文檔對此沒有任何意見，所以我很困惑。

任何人都可以幫忙做些什麼？

Answer 1

你不能真正對角項目中使用JSDOC，因爲你基本上可以寫打字稿，但有其他替代JSDOC，支持一些JSDOC格式化語法，像typedoc和compodoc，後者主要是專注於Angular項目。