在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项目。