有没有办法生成像Google Closure Library API文档这样的Javascript API文档？

Question

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

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

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使用的特定生成器是否可用于我自己的源（如果这很重要的话，它将是开源的。）

提前致谢...

Answer 1

Google Closure + JSDoc

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

谷歌闭包工具都是开源的，除了目前尚未披露的一些比特。无论如何，您可以查看文档和源代码，看看它们用于生成Javadoc的内容。

ExtJS + Ext-Doc

另一个你可能会看到灵感，看看他们是如何做到的是online doc for ExtJS。我发现首先导航有点令人困惑，但你很快就习惯了。一个开源项目Ext-Doc生成类似样式的文档，虽然它现在有点过时了。

YUI Doc

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

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

Answer 2

结帐YUI Doc。

Answer 3

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

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

Answer 4

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

您可以使用gulp https://github.com/documentationjs/gulp-documentation

运行它

Answer 5

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

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