jQuery 兼容的 JavaScript 文档生成器答案

【问题标题】：jQuery compatible JavaScript documentation generatorjQuery 兼容的 JavaScript 文档生成器
【发布时间】：2011-05-28 17:54:54
【问题描述】：

我需要为我的 javascript 项目（使用 jquery、下划线和主干构建）选择一个文档生成器（类似于 java 中的 jdoc 或 ruby 中的 rdoc）

候选人：

要求

【问题讨论】：

【解决方案1】：

我会把 Sencha 的 jsduck 放在首位。我在很多项目中都使用过它。使用简单

单个命令将生成像这样的文档http://docs.sencha.com/touch/2-0/

【讨论】：

【解决方案2】：

您还可以查看 TJ Holowaychuk 的 Dox；它是 Docco 的一个分支，但添加了一些 jsDoc 语法支持。我个人发现 jQuery 代码通常适用于像 Docco 这样松散的内联文档风格，但我目前处于尝试决定使用哪种文档系统的相同情况。

【讨论】：

【解决方案3】：

我现在正在做同样的练习，从我所看到的 YUI Doc 来看是最好的。我喜欢您可以在“服务器”模式下运行它并在编写文档时查看文档的事实。比每次更改文档时都必须执行构建要好得多。此外，生成的文档非常易于阅读且组织良好。

【讨论】：

【解决方案4】：

这是新的，因此它可能不符合您的输出要求，但您可能会发现 njsdoc 很有趣。与大多数 JS 文档工具不同，它尝试通过执行代码和调查堆栈来构建文档，而不仅仅是解析文件以获取注释。

【讨论】：

【解决方案5】：

有DocumentJS*

*我没有使用过，我不确定它与 Backbone 的集成效果如何。

【讨论】：