javascript - 寻找基于jsdoc的汽车API文档wiki解决方案

Question

我们有一大段 JS 代码，用 jsdoc 语法记录，我们希望以自动方式将其包含在内部 wiki 中。

因此，我正在寻找能够从我们的代码库中使用 jsdoc 自动生成页面的 wiki 解决方案。

任何想法 ？

Answer 1

1. 首先，我建议使用以下命令检查应用程序代码是否具有有效且完整的 jsdoc eslint：valid-jsdoc。

2. 可以从有效的 jsdoc 生成：

   • 使用来自jsdoc的默认模板生成器
   • 一个简单的工具docdown，它生成 markdown
   • 一个更复杂的Docdash，带有模板（lodash.com 之类）、导出配置等选项。它生成一个完整的 html。

Answer 2

您可以使用 JSDoc 的内置功能从源代码生成并将您自己的模板应用到它。然后从您的 WIKI 链接到它生成的 HTML 页面。您可以通过使用 cron 每次运行 JSDoc 的页面生成器来自动执行此操作，并使用它的模板功能使其看起来与您的 wiki 完全一样，因此当您从 wiki 链接到它时，它看起来并没有什么不同。这就是我们所做的。