如何在Windows上使用JSDoc

Question

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

Answer 1

您可以将其作为Node.js JavaScript运行时环境的npm包下载。

1. 安装npm附带的Node.js
2. 打开a命令行

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

   npm install -g jsdoc

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

   jsdoc path/to/file.js

5. 配置jsdoc（可选）

Answer 2

项目页面上没有很好地记录安装。

它在github页面上的解释要好得多。

Answer 3

我对NodeJS/npm生态系统了解不多。然而，我做了以下步骤，它对我有效（在窗口上）：

1. 下载NodeJS zip文件并提取，它创建了一个目录"node-v16.15.1-win-x64"，其中包含node.exe和npm.cmd
2. 执行命令"npm install-g jsdoc"，在"node-v16.15.1-win-x64"下的"node_modules"目录下，它安装了jsdoc（在文件夹中），并在"node-v16.15.1-win x64"内创建了jsdoc.cmd文件
3. 这个jsdoc.cmd可以使用完整路径，但没有完整路径就无法使用jsdoc已安装并使用上述步骤，但要在不提供完整路径的情况下从任何位置访问它，我必须在Windows path上设置"node-v16.15.1-win-x64"，这是有效的

我不确定OP的问题是否得到了回答，但JSDoc以这种方式为我工作。

Answer 4

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

1. 安装node.js

2. 打开命令提示符

3. 作为测试，在根驱动器（c:test）中创建一个文件夹并转到它（cdtest）。我想是有某种权限问题，因为我无法在桌面文件夹中执行以下步骤。

4. 安装JSDoc包：npm install jsdoc

5. test中应该有一个名为node_modules 的文件夹

6. 转到node_modules 中的.bin子文件夹

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