Question

我正在开发一个Angular 4项目，我从Angular CLI构建。

接下来我要安装JSDOC

我按照说明做了这个：

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

所以，现在我安装了它。

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

它在运行此命令的文档中说：

jsdoc yourJavaScriptFile.js

＆＃34; yourJavascriptFile.js＆＃34;是什么意思？？我使用的是Angular，它使用的是typescript ...并且它不应该扫描所有的typescript文件以获取注释然后生成文档吗？

官方文档中没有任何内容，所以我真的很困惑。

任何人都可以帮忙做什么？

Answer 1

你实际上不能在Angular项目上使用JSDOC，因为你基本上是在编写Typescript，然而还有其他JSDOC的替代品，它支持一些JSDOC格式的语法，比如{{3} }和typedoc，后者主要关注Angular项目。

Answer 2

我尝试将其与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>

在Angular项目上运行的JavaScript JSDoc

2 个答案: