代码之家 › 专栏 › 技术社区 › Homer6

有没有一种方法可以生成Javascript API文档,比如Google闭包库API文档?

google-closure-library google-closure documentation-generation javascript

30

Homer6 · 技术社区 · 14 年前

有人知道Google用来生成以下url接口的工具是开源的吗?我能产生类似的输出吗?

但是我想知道Google使用的特定生成器是否可以用于我自己的源代码(如果有必要的话,它将是开源的)。

提前谢谢。。。

5 回复 | 直到 14 年前

1

28

Community CDub 8 年前

谷歌关闭+JSDoc

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

Google关闭工具都是开源的,除了一些目前还没有公开的东西。在任何情况下,您都可以查看文档和源代码,了解它们用于生成Javadocs的内容。

另一个你可以看看的灵感,看看他们是如何做到这一点是 online doc for ExtJS Ext-Doc ,生成具有类似样式的文档,尽管它现在有点过时。

As mentioned by Matthew Manela ,YUI Doc也提供了相当好的在线文档。

我的建议是使用JSDoc,因为它实际上是许多工具的标准,而且它反映了Java实践,但它实际上取决于您想要什么。

2

Matthew Manela 14 年前

退房 YUI Doc .

3

2

Utensil 13 年前

对于不使用ExtJS但熟悉Ruby的用户, https://github.com/b-studios/doc.js

4

2

Andrew 9 年前

5

1

owler 8 年前

Dossier 目前(2016年)用于建造 Closure Library documentation . 它是一个构建在闭包编译器本身之上的极好的工具,因此它实际上使用编译器读取所有类型信息,然后输出文档而不是代码。

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