在角度项目上运行的JavaScript JSDoc

Question

我正在做一个角4项目，我从角CLI构建。

接下来我要安装JSDOC

我是按照指示做的：

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

所以，现在我安装了它。

我的问题是...我接下来要做什么来生成文档文件？

它在留档中说要运行这个命令：

jsdoc yourJavaScriptFile.js

"你的JavascriptFile.js"是什么意思？我正在使用Angular，它使用打字稿...它不应该扫描我所有的打字稿文件以获取评论，然后生成文档吗？

官方文件中没有这方面的内容，所以我真的很困惑。

有人能帮忙做什么吗？

Answer 1

我曾尝试使用它与角5生成PDF与打字稿。不完全是问什么，但也许可以帮助某人：首先，npm安装jspdf-保存然后安装键入npm安装@type/jspdf-保存-dev然后：

import * as jsPDF from 'jspdf';

 downloadPDF(){
    const doc = new jsPDF();
    doc.text("First name: " + this.userData.firstName, 10, 10);
    doc.save('UserData.pdf');
 }

在模板中：

<button type="button" pButton (click)="downloadPDF()" label="Download PDF"></button>

Answer 2

你实际上不能在Angular项目上使用JSDOC，因为你基本上是在写TypeScript，但是还有其他JSDOC的替代品，它支持一些JSDOC格式的语法，比如typedoc和compodoc，后者主要集中在Angular项目上。