如何在Windows上使用JSDoc?

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

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

  1. 安装npm附带的Node.js
  2. 打开你的命令行
  3. 输入以下命令来安装JsDoc

    npm install -g jsdoc

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

    jsdoc path/to/file.js

  5. 配置jsdoc (可选)

好的,所以我觉得我知道了。 我并不是说这一定是说这是正确的方法,但它对我有效。 开始:

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