如何在 Windows 上使用 JSDoc？

Question

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

Answer 1

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

1. 安装npm自带的Node.js
2. 打开你的命令行

3. 输入以下命令安装 JsDoc

   npm install -g jsdoc

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

   jsdoc path/to/file.js

5. 配置jsdoc （可选）

Answer 2

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

在github-page上解释得更好。

Answer 3

我不太了解 NodeJS/npm 生态系统。 但是，我执行了以下步骤，它对我有用（在 Windows 上）：

1. 下载NodeJS zip文件并解压，它用node.exe和npm.cmd创建了一个目录'node-v16.15.1-win-x64'
2. 执行命令'npm install -g jsdoc'，在'node-v16.15.1-win-x64'下的'node_modules'目录下，它安装了jsdoc（在一个文件夹中），并在'node- v16.15.1-win-x64'。
3. 此 jsdoc.cmd 使用完整路径，但如果没有安装完整路径 jsdoc 并且正在使用上述步骤，但要从任何地方访问它而不提供完整路径，我必须设置'node-v16 Windows PATH 上的 .15.1-win-x64' 有效。

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

Answer 4

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

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 脚本