寻找基于jsdoc的自动API文档维基解决方案

Question

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

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

有什么想法吗？

Answer 1

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

Answer 2

1. 首先，我建议检查，如果应用程序代码使用eslint valid-jsdoc有效且完整的jsdoc。

2. 可以生成有效的jsdoc：

   • 使用jsdoc
   中的默认模板生成器
   • 一个生成降价的简单工具docdown
   • 更复杂的Docdash，其中包含模板（lodash.com之类），导出配置等选项。它会生成完整的HTML。