Javascript JSDoc设置？

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

关于如何启动和运行它的教程在这里

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

有人能给我一个关于如何让JSDoc真正工作，如何设置它，如何使用它等一步一步的指导吗

---

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

嗯，你是在使用windows还是GNU/Linux？ 首先，必须按照默认标记标记源代码，标识类、方法、参数等。。。 之后，您可以在此处下载该文件： 解压缩它，然后转到文件夹jsdoc master

在它里面，有一个名为jsdoc的脚本，没有扩展名。您只需执行它，将整个路径指向您想要创建如下文档的.js文件：./jsdoc your_class.js 然后，几分钟后，您将在“out”文件夹中获得输出。打开.html文件，砰的一声！你的文档工作得很好

在这里，您可以找到一些常用标记，在代码中用作注释：

此解决方案适用于基于Unix的系统。但是，还有一个使用nodejs的，可以在windows、Linux、mac等环境下运行。。。。首先，在此处下载节点：

然后访问此网站查看jsdoc包：

然后，在安装完节点后，返回到任何操作系统中的终端并键入：npm install-g jsdoc 选项-g表示全局，因此您在节点包的主文件夹中有，它们可用于您拥有的任何项目，您无需反复安装它

最后，您可以使用以下命令：jsdoc path/to/your/file.js

---

就这样！我希望它能帮助您。

那么，您是在使用windows还是GNU/Linux？ 首先，必须按照默认标记标记源代码，标识类、方法、参数等。。。 之后，您可以在此处下载该文件： 解压缩它，然后转到文件夹jsdoc master

在它里面，有一个名为jsdoc的脚本，没有扩展名。您只需执行它，将整个路径指向您想要创建如下文档的.js文件：./jsdoc your_class.js 然后，几分钟后，您将在“out”文件夹中获得输出。打开.html文件，砰的一声！你的文档工作得很好

在这里，您可以找到一些常用标记，在代码中用作注释：

此解决方案适用于基于Unix的系统。但是，还有一个使用nodejs的，可以在windows、Linux、mac等环境下运行。。。。首先，在此处下载节点：

然后访问此网站查看jsdoc包：

然后，在安装完节点后，返回到任何操作系统中的终端并键入：npm install-g jsdoc 选项-g表示全局，因此您在节点包的主文件夹中有，它们可用于您拥有的任何项目，您无需反复安装它

最后，您可以使用以下命令：jsdoc path/to/your/file.js

---

就这样！我希望它对您有所帮助。

提取从github下载的文件后，在文件夹中导航并在终端中运行：

./jsdoc 

有你想要的选择

如果要显示“帮助”菜单

./jsdoc --help

如果要在系统上安装该程序（假设为mac或linux计算机），请使用root用户或sudo：

---

提取从github下载的文件后，在文件夹中导航并在终端中运行：

./jsdoc 

有你想要的选择

如果要显示“帮助”菜单

./jsdoc --help

如果要在系统上安装该程序（假设为mac或linux计算机），请使用root用户或sudo：