javascript - 有没有办法像 Google Closure Library API 文档那样生成 Javascript API 文档？

Question

我正在尝试为我的 Javascript 源代码生成 HTML 文档的工具。

有谁知道谷歌用来在以下网址生成界面的工具是否是开源的？我能产生类似的输出吗？

但我想知道谷歌使用的特定生成器是否可供我用于我自己的源代码（如果这很重要，这将是开源的）。

提前致谢...

score 28 · Accepted Answer

谷歌关闭 + JSDoc

正如您在评论中提到的那样，它们构建在JSDoc Toolkit之上，以添加闭包编译器用于类型检查和其他事情的特殊注释，但这意味着您也可以在闭包代码之上使用 JSDoc 来生成文档。生成具有所需外观和感觉的输出只需要编写自己的模板和样式表即可。

Google Closure Tools 都是开源的，除了一些暂时没有公开的部分。在任何情况下，您都可以查看文档和源代码，了解它们用于生成 Javadocs 的内容。

另一个您可以查看灵感并了解他们如何做到这一点的是ExtJS 的在线文档。一开始我觉得导航有点混乱，但你很快就习惯了。一个开源项目Ext-Doc生成具有类似风格的文档，尽管它现在有点过时了。

正如 Matthew Manela 所提到的，YUI Doc 也产生了非常好的在线文档。

我的建议是选择 JSDoc，因为它是许多工具的事实上的标准，它反映了 Java 实践，但它真的取决于你想要什么。

score 2 · Accepted Answer

2

于 2010-09-29T05:11:32.207 回答

score 2 · Accepted Answer

对于使用 ExtJs 的人来说，https://github.com/senchalabs/jsduck非常棒。

对于不使用 ExtJS 但熟悉 Ruby 的人来说，https://github.com/b-studios/doc.js很棒。

score 2 · Accepted Answer

较新的选项是http://documentation.js.org/，它使用 JSDoc 并生成 HTML：

score 1 · Accepted Answer

Dossier目前（2016 年）被用于构建Closure Library 文档。它是构建在 Closure Compiler 本身之上的出色工具，因此它实际上使用编译器读取所有类型信息，然后输出文档而不是代码。

关于文档的用户界面，仍有一些事情正在解决中。目前，Closure Library 文档页面看起来相当空——您必须单击左上角的“汉堡菜单”符号才能开始。