请原谅我,如果这是一个愚蠢的问题,但我完全不知道如何在Windows上使用JSDoc。我知道JSDoc-Toolkit,但它有点过时了,谷歌代码库建议使用JSDoc 3。我从Github下载了JSDoc,并将jsdoc-master文件夹解压缩到我的本地磁盘上,但是找不到任何关于如何使用它来解析我的文件的可靠信息。
答案 0 :(得分:17)
输入以下命令
安装JsDoc npm install -g jsdoc
运行JsDoc / generate文档。 more info
jsdoc path/to/file.js
Configure jsdoc(可选)
答案 1 :(得分:0)
在project-page上记录的安装不正确。
最好在github-page上加以解释。
答案 2 :(得分:-1)
好的,所以我想我想出来了。我并不是说这必然是说这是正确的方法,但它对我有用。这是:
1)安装node.js
2)打开命令提示符
3)作为测试,在根驱动器(c:\test
)中创建一个文件夹并转到它(cd\test
)。我想有一些权限问题,因为我无法在桌面文件夹中使用以下步骤。
4)安装JSDoc软件包:npm -install jsdoc
5)test
中应该有一个名为node_modules
6)转到.bin
node_modules
子文件夹
7)应该有一个名为jsdoc.cmd
的文件。在命令提示符中简单地使用jsdoc myfile.js
来执行文件中的JSDoc脚本