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

【问题标题】：Is there a way to generate Javascript API documentation like the Google Closure Library API Documentation?有没有办法像 Google Closure Library API 文档那样生成 Javascript API 文档？
【发布时间】：2010-09-29 05:09:19
【问题描述】：

我正在尝试寻找一种工具来为我的 Javascript 源代码生成 HTML 文档。

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

http://closure-library.googlecode.com/svn/docs/class_goog_proto2_Serializer.html

http://closure-library.googlecode.com/svn/docs/namespace_goog_date.html

http://closure-library.googlecode.com/svn/docs/namespace_goog_events.html

http://closure-library.googlecode.com/svn/docs/class_goog_gears_Database.html

http://closure-library.googlecode.com/svn/docs/class_goog_ui_DatePicker.html

我知道http://code.google.com/p/jsdoc-toolkit/

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

提前谢谢...

【问题讨论】：

发现这句话“google 闭包编译器使用 JSDoc 文档系统，该系统同时（如果由程序员正确创建）提供文档并在编译时捕获许多错误。”来自stackoverflow.com/questions/1690197/… 想了解更多...

标签： javascript documentation-generation google-closure google-closure-library

【解决方案1】：

谷歌关闭 + JSDoc

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

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

ExtJS + Ext-Doc

另一个您可能会从online doc for ExtJS 那里获得灵感并了解他们是如何做到的。一开始我觉得导航有点混乱，但你很快就习惯了。一个开源项目，Ext-Doc，生成了类似风格的文档，虽然它现在有点过时了。

YUI 文档

As mentioned by Matthew Manela，YUI Doc 也产生了相当不错的在线文档。

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

【讨论】：

JSDoc工具包的文档注解和Google Closure不一样，这是为什么呢？更重要的是，是否可以使用 Google Closure 的某些部分生成文档？他们的在线 API 参考看起来很棒。
@Betamos：抱歉，从未注意到您的后续问题。 Closure 的文档格式与 JSDoc 不完全相同的原因是，据我所知，它们添加了自己的一组参数。
@Betamos：另外，最有可能以与他们相同的方式生成文档。然而，这可能需要大量的黑客攻击，因为他们的工具会为他们的库生成文档。也许你可以尝试让它生成另一个文档，但我不能对这样做的难度做出任何假设。

【解决方案2】：

查看YUI Doc。

【讨论】：

【解决方案3】：

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

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

【讨论】：

我最近用 JSduck 做 extjs... 印象非常深刻！ +1 为优秀的建议。

【解决方案4】：

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

你可以用 gulp https://github.com/documentationjs/gulp-documentation 运行它

【讨论】：

【解决方案5】：

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

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

【讨论】：

非常感谢！我认为这是迄今为止最好的 javascript 文档生成器！