我不擅长计算机，但我正在尝试将JSDoc用于我的一个项目，
启动并运行的教程就在这里
http://usejsdoc.org/about-jsdoc3.html
我从github下载了程序，但现在不明白我要做什么。我在一个文件夹中有一堆文件，不知道如何让它实际运行我的项目。
有人可以给我一步一步说明如何让JSDoc正常工作，如何设置，如何使用它等等。
我知道这对你们中的一些人来说可能是平凡的，但嘿，我们都要从某个地方开始吧？
答案 0 :(得分：6)
嗯，你使用的是Windows还是GNU / Linux？ 首先，您必须遵循默认标记来标记您的源代码，识别您的类，方法，参数等... 之后，您可以在此处下载文件：https://github.com/jsdoc3/jsdoc 解压缩然后转到文件夹jsdoc-master。
在其中，你有一个名为jsdoc的脚本（没有扩展名）。只有你需要做的是执行它指向你想要创建如下文档的.js文件的整个路径：./ jsdoc your_class.js 然后，在几分钟内，您将在'out'文件夹中输出输出。打开.html文件然后爆炸！你的文档工作得很好。
在这里，您可以找到一些常用标记（在评论中使用）：http://usejsdoc.org/
此解决方案适用于基于Unix的系统。但是，还有另一个使用nodejs（你可以运行windows，Linux，mac等等）。首先，在此处下载nodejs：http://nodejs.org/
然后访问此网站，查看包jsdoc：https://npmjs.org/
然后，返回终端（在安装节点后的任何操作系统中）并输入：npm install -g jsdoc 选项-g意味着全局，所以你有你的节点包的主文件夹，它们可用于你拥有的任何项目，你不需要一次又一次地安装它......
最后，你可以使用这个命令：jsdoc path / to / your / file.js
就是这样！我希望它可以帮助你。
答案 1 :(得分：0)
一旦你从github下载了你下载的文件，在文件夹中导航并在终端中运行：
./jsdoc
使用您想要的选项。
如果要显示帮助菜单
./jsdoc --help
如果要在系统上安装程序，假设有mac或linux机器，请使用root用户或sudo：
npm install --save -g [~/Downloads/jsdoc-3.2.2 or your path to the downloaded extracted files]