javascript - JSDoc 设置？

Question

我不太擅长计算机，但我正在尝试将 JSDoc 用于我的一个项目，

启动和运行它的教程在这里

http://usejsdoc.org/about-jsdoc3.html

我已经从github下载了程序，但现在不明白我必须做什么。我在一个文件夹中有一堆文件，不知道如何让它为我的项目实际运行。

有人可以给我一步一步的指导，告诉我如何真正让 JSDoc 工作，我如何设置它，我如何使用它等等。

我知道这对你们中的一些人来说可能是平凡的，但是嘿，我们都必须从某个地方开始，对吧？

Answer 1

那么，您使用的是 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

就是这样！我希望它对你有帮助。

Answer 2

解压缩从 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]