在 Angular 项目上运行的 JavaScript JSDoc答案

【问题标题】：JavaScript JSDoc running on an Angular project在 Angular 项目上运行的 JavaScript JSDoc
【发布时间】：2018-03-27 16:57:30
【问题描述】：

我正在开发一个使用 Angular CLI 构建的 Angular 4 项目。

接下来我要安装JSDOC

我是按照说明进行的：

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

所以，现在我已经安装了它。

我的问题是……接下来我该怎么做才能生成 doc 文件？

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

jsdoc yourJavaScriptFile.js

“yourJavascriptFile.js”是什么意思？我正在使用 Angular，它使用打字稿......它不应该扫描我所有的打字稿文件以查找 cmets 然后生成文档吗？

官方文档对此一无所知，所以我真的很困惑。

有人可以帮忙吗？

【问题讨论】：

标签： javascript angular jsdoc jsdoc3

【解决方案1】：

我尝试将它与 angular 5 一起使用来生成带有打字稿的 pdf。不完全是问什么，但也许可以帮助某人：首先，npm install jspdf --save 然后安装类型npm install @types/jspdf --save-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>

【讨论】：

【解决方案2】：

您实际上不能在 Angular 项目中使用 JSDOC，因为您基本上是在编写 Typescript，然而还有其他 JSDOC 替代方案，它们支持一些 JSDOC 格式的语法，例如 typedoc 和compodoc，后者主要关注Angular项目。

【讨论】：