如何在 Windows 上使用 JSDoc？

Question

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

Answer 1

我并不是说这一定是最好的方法，但它对我有用：

1. 安装node.js

2. 打开命令提示符

3. 作为测试，在您的根驱动器 (c:\test) 中创建一个文件夹并转到该文件夹​​ (cd\test)。我猜是存在某种权限问题，因为我无法在我的桌面文件夹中执行以下步骤。

4. 安装 JSDoc 包：npm install jsdoc

5. test 中应该有一个名为 node_modules

   的文件夹

6. 转到 node_modules

   中的 .bin 子文件夹

7. 应该有一个名为 jsdoc.cmd 的文件。只需在命令提示符中使用 jsdoc myfile.js 即可在您的文件

   上执行 JSDoc 脚本

Answer 2

你可以download it as an npm package for the Node.js JavaScript runtime environment.

1. 安装Node.js which comes with npm
2. 打开命令行

3. 输入以下命令安装 JsDoc

   npm install -g jsdoc

4. 运行 JsDoc / 生成文档。 more info

   jsdoc path/to/file.js

5. Configure jsdoc（可选）

Answer 3

安装不好记录在project-page.

在 github-page 上有更好的解释。