如何在Windows上使用JSDoc? [英] How do I use JSDoc on Windows?

问题描述

如果这是一个愚蠢的问题，请原谅我，但我对如何在Windows上使用JSDoc感到困惑.我知道JSDoc-Toolkit，但是它有点过时了，Google代码存储库建议改用JSDoc 3.我已经从Github下载了JSDoc，并将jsdoc-master文件夹解压缩到本地磁盘上，但是找不到有关如何使用它解析文件的任何可靠信息.

Forgive me if this is a daft question but I'm utterly baffled as to how I can use JSDoc on Windows. I'm aware of JSDoc-Toolkit but it's a bit out of date and the google code repository recommends to use JSDoc 3 instead. I have downloaded JSDoc from Github and unzipped the jsdoc-master folder onto my local disk but can't find any solid information as to how to use it to parse my files.

推荐答案

您可以将其下载为npm软件包 Node.js JavaScript运行时环境.

1. 安装 npm <随附的 Node.js /a>
2. 打开命令行

3. 通过键入以下命令来安装JsDoc

1. Install Node.js which comes with npm
2. Open your a command line

3. Install JsDoc by typing the following command

npm install -g jsdoc

运行JsDoc/生成文档. 更多信息

Run JsDoc / generate documentation. more info

jsdoc path/to/file.js

配置jsdoc (可选)

这篇关于如何在Windows上使用JSDoc?的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！