36

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

候选人：

要求

  • 应该与 jquery、下划线和骨干一起使用。这意味着对象文字方法等
  • 我真的很喜欢 pdoc，但它太以原型为中心，文档记录很差，而且我不想制作额外的文件（部分？）来使其工作（不确定这一点）
  • docco 很好，但我想要结构化输出（如菜单 + 类/函数结构，如 jdoc）
  • 必须与命令行/makefile 兼容（不是网络粘贴）

非常欢迎提示、技巧、教程、成功案例和建议。

为什么 jQuery 不使用 JSDoc？

4

5 回答 5

5

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

https://github.com/senchalabs/jsduck

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

于 2012-08-09T14:19:07.187 回答
1

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

于 2011-06-30T21:54:34.590 回答
1

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

https://bitbucket.org/nexj/njsdoc

于 2012-11-29T20:27:09.310 回答
1

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

于 2012-08-27T16:10:54.350 回答
-1

有DocumentJS *

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

于 2011-06-27T15:20:19.993 回答