如何在 Windows 上使用 JSDoc？答案

【问题标题】：How do I use JSDoc on Windows?如何在 Windows 上使用 JSDoc？
【发布时间】：2020-09-01 03:30:14
【问题描述】：

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

【问题讨论】：

网站上的文档不是很清楚如何安装它。我感觉到你了。

标签： javascript windows jsdoc

【解决方案1】：

您可以download it as an npm package 为Node.js JavaScript runtime environment.

安装Node.js 附带npm
打开你的命令行
通过键入以下命令安装 JsDoc

npm install -g jsdoc
运行 JsDoc / 生成文档。 more info

jsdoc path/to/file.js
Configure jsdoc（可选）

【讨论】：

谢谢，-g 选项非常有用！无需从 .bin 文件夹运行它
即便如此，您也不需要从.bin 文件夹运行它。 npm 创建node_modules 文件夹并将包安装在当前工作目录中，除非通过-g 选项。因此，如果您没有在全局范围内安装它，您应该在运行npm install之前cd path/to/project_root
谢谢，最后一个问题：全局安装时，jsdoc 文件夹放在哪里（这样我可以把模板放在那里）？我在 D:\node 上安装了 node.js，并且我检查了 node_modules 子文件夹（包括在 npm 中）。
其实我很抱歉，你说对了一半。如果您没有全局安装它，您要么需要将 cd 向下到 .bin 文件夹，要么将 jsdoc 的路径添加到命令的开头 - 我拒绝更具体，因为这是错误的做法它。 您应该始终全局安装 jsdoc。
我很确定在 Windows 上它会将全局节点模块放入您的用户文件夹 C:/Users/<you>/node_modules

【解决方案2】：

project-page 上没有很好地记录安装。

github-page 上的解释要好得多。

【讨论】：

【解决方案3】：

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

安装node.js
打开命令提示符
作为测试，在您的根驱动器 (c:\test) 中创建一个文件夹并转到它 (cd\test)。我猜可能存在某种权限问题，因为我无法在我的桌面文件夹中执行以下步骤。
安装JSDoc包：npm install jsdoc
test 中应该有一个名为 node_modules 的文件夹
转到node_modules 中的.bin 子文件夹
应该有一个名为jsdoc.cmd 的文件。在命令提示符下简单使用jsdoc myfile.js 对你的文件执行JSDoc脚本

【讨论】：

您需要将第4步更改为npm install -g jsdoc，并且您无需在node_modules文件夹中执行任何操作。