有没有一种方法可以生成类似于Google Closure Library API文档的Javascript API文档？

Question

30

我正在寻找一种工具，可以为我的Javascript源代码生成HTML文档。

有人知道Google用来生成以下URL界面的工具是否是开源的吗？我能否生成类似的输出呢？

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

提前致谢...

- Homer6

发现了这句话：“Google Closure Compiler使用JSDoc文档系统，如果程序员正确创建，可以同时提供文档并在编译时捕获许多错误。” 来自https://dev59.com/6nI-5IYBdhLWcg3wwbVL#2339186。想要了解更多... - Homer6

5个回答

2

一种较新的选择是使用 JSDoc 并生成 HTML 的 http://documentation.js.org/:

- Andrew

2

请查看YUI Doc。

- Matthew Manela

2

如果您使用ExtJs，那么https://github.com/senchalabs/jsduck非常棒。

如果您不使用ExtJS但熟悉Ruby，那么https://github.com/b-studios/doc.js很棒。

- Utensil

我最近在ExtJS中使用了JSduck... 我非常印象深刻！对于这个出色的建议，我点赞。 - Homer6

1

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

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

- owler

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

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- haylem · Accepted Answer

Google Closure + JSDoc

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

Google Closure Tools都是开源的，除了一些目前未公开的部分。无论如何，您都可以查看文档和源代码，并查看它们用来生成Javadocs的内容。

另一个您可能可以参考并查看其操作方式的是ExtJS在线文档。我发现最初导航有点混乱，但您很快就会习惯。一个开源项目，Ext-Doc，生成了具有类似风格的文档，尽管现在有点过时。

正如Matthew Manela所提到的那样，YUI Doc也能产生相当不错的在线文档。

我的建议是选择 JSDoc，因为它是许多工具的事实标准，并反映了 Java 的惯例，但最终取决于你的需求。