【发布时间】:2017-08-20 11:04:33
【问题描述】:
有没有办法在线或使用独立工具从 jsdocs 生成 html?我已经创建了一个内部 JS 库并使用 JSDoc 规范对其进行了记录,现在想生成文档以与我的团队共享。由于我不会进入的原因,我不能像在家一样安装 jsdoc npm 包。
那么有没有办法在不安装 JSDoc 的情况下生成 html 文档(或类似文档)?
【问题讨论】:
有没有办法在线或使用独立工具从 jsdocs 生成 html?我已经创建了一个内部 JS 库并使用 JSDoc 规范对其进行了记录,现在想生成文档以与我的团队共享。由于我不会进入的原因,我不能像在家一样安装 jsdoc npm 包。
那么有没有办法在不安装 JSDoc 的情况下生成 html 文档(或类似文档)?
【问题讨论】:
如果您由于某种原因无法安装 JSDoc 实用程序,我仍然会实现一个使用 javascript 并输出 html 并在您控制的服务器上启动它的最小服务器。最少的工作,您无需在您的计算机上安装即可获得您想要的。
你会这样做
curl -X POST private-server.com/jsdoc-service ---data @my-javascript.js
并取回 html。或者,将整个项目捆绑为一个 zip 并发布,在服务器上解压缩,运行该工具并返回一个 zip。轻松小便。
【讨论】:
可能不是内部库的解决方案,但如果你的代码托管在 GitHub 上,你可以使用https://doxdox.org/
https://doxdox.org/<username>/<repo>
【讨论】:
如果你需要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(或您的公司)的知识产权,并将其发送到任何 3rd 方服务,甚至生成文档听起来很奇怪。我会在家里生成文档并将其用于您的案例。
【讨论】: