在线生成的JSDoc

Question

有没有一种方法可以从jsdocs在线或使用独立工具生成html？我已经创建了一个内部JS库，并用JSDoc规范记录了它，现在我想生成文档与我的团队分享。我不能像在家里那样安装jsdoc npm包。

那么，有没有一种方法可以在不安装JSDoc的情况下生成html文档(或类似文档)？

Answer 1

如果您需要JSDoc文档，则需要安装或复制JSDoc package。由于该包是基于JavaScript的，因此您需要事先在计算机上安装node.js，作为JS运行时环境。如果您的工作计算机上安装了node.js，则可以安装该软件包

npm install -g jsdoc 

或者(从您的家庭计算机)将"node_modules/.bin“和"node_modules/jsdoc”文件夹复制到您的工作计算机上的任何位置。使用command line生成文档后

.bin/jsdoc path/to/file.js

关于这个主题的更多信息在这里：How do I use JSDoc on Windows?。

注意:我不知道有任何在线服务来生成JS文档，但即使我会，我也不建议您使用它。您编写的脚本是ypur (或您的公司)的知识产权，并将其发送到任何第三方服务，甚至生成文档听起来很奇怪。我会在家里生成文档，并将其带到您的案例中工作。

Answer 2

也许不是内部库的解决方案，但是如果您的代码托管在GitHub上，那么您可以使用https://doxdox.org/

https://doxdox.org/<username>/<repo>

Answer 3

如果您由于某种原因不能安装JSDoc实用程序，我仍然会实现一个使用javascript和输出html的最小服务器，并在您控制的服务器上启动它。最少的工作，你不需要安装在你的电脑上就能得到你想要的东西。

然后你就会这样做

curl -X POST private-server.com/jsdoc-service ---data @my-javascript.js

然后把html拿回来。或者，将整个项目打包为zip，然后在服务器上解压缩，运行该工具并返回zip。轻轻松松。