javascript - 是否有办法生成Javascript文档( 如Google文档)?

  显示原文与译文双语对照的内容
85 4

我试图找到一个能够为我的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使用的特定发生器是否可以用于我自己的源( 那将是开源的如果可以的话) 。

请提前致谢。

时间: 原作者:

91 5

Google关闭+ JSDoc

,注释,they编译编译器使用special添加特殊注解,但这意味着你也可以在关闭代码中使用 JSDoc,而这意味着你也可以使用JSDoc来生成文档。 使用所需的外观生成输出只是编写自己的模板和样式表的问题。

除了一些没有公开的位,Google闭包工具都是开源的。 在任何情况下,你都可以看到文档和源代码,看看它们使用的是哪些内容。

EXTJS + ext文档

另一个你可以能会看到灵感,看看它们是如何做到的在线文档的EXTJS for 。 我发现首先导航会有点混乱,但是你会很快习惯它的。 一个开放源码项目,,生成具有类似样式的文档,虽然现在有点过时了。

YUI 文档

就像 Matthew 所提到的,YUI Doc也生成了非常好的在线文档。

我的建议是,因为它是许多工具的实际标准,它反映了Java实践。

原作者:
89 2

对于使用 EXTJS的用户来说, https://github.com/senchalabs/jsduck 是非常棒的。

对于那些不使用 EXTJS 但熟悉 ruby的用户来说, https://github.com/b-studios/doc.js 是很好的。

原作者:
...