JSDoc在线生成

时间:2017-03-27 16:15:31

标签: jsdoc jsdoc3

有没有办法从jsdocs在线或使用独立工具生成html?我已经创建了一个内部JS库并使用JSDoc规范对其进行了记录,现在我想生成与我的团队共享的文档。我不能,因为我不会进入的原因,安装jsdoc npm软件包就像我在家里一样。

那么有没有办法在不安装JSDoc的情况下生成html文档(或类似文档)?

4 个答案:

答案 0 :(得分: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(或您的公司)知识产权,并将其发送给任何第三方服务,甚至生成文档听起来很奇怪。我会在家里生成文档并将其用于您的工作。

答案 1 :(得分:1)

sanstv.ru中有一个在线生成器,它当然非常慢。

我在iPad上遇到它并且是最好的选择,但你应该安装jsdoc

https://sanstv.ru/jsdoc

确实很惊人,那里已经没有了。

干杯,

答案 2 :(得分:0)

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

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

答案 3 :(得分:0)

如果您由于某种原因无法安装 JSDoc 实用程序,我仍然会实现一个使用 javascript 并输出 html 的最小服务器,然后在您控制的服务器上启动它。只需最少的工作,无需在您的 计算机上安装即可获得所需的内容。

然后你就可以了

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

并取回 html。或者,将整个项目捆绑为一个 zip 和 POST,在服务器上解压缩,运行该工具并返回一个 zip。容易尿尿。