首页 文章

在Angular项目上运行的JavaScript JSDoc

提问于
浏览
-1

我正在开发一个Angular 4项目,我从Angular CLI构建 .

接下来我要安装JSDOC

我按照说明做了这个:

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

所以,现在我安装了它 .

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

它在文档中说运行此命令:

jsdoc yourJavaScriptFile.js

“yourJavascriptFile.js”是什么意思?我正在使用Angular,它使用的是typescript ...并且它不应该扫描我的所有typescript文件以获取注释然后生成文档?

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

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

2 回答

  • 1

    您基本上可以编写Typescript,但是JSDOC还有其他替代方法,它支持一些JSDOC格式的语法,如typedoccompodoc,后者主要关注Angular项目 .

  • 0

    我试图用角度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>
    

相关问题