jQuery兼容的JavaScript文档生成器
我需要select一个文档生成器(类似于java中的jdoc或Ruby中的rdoc)为我的JavaScript项目(用jQuery,下划线和骨干构build)
候选人:
- jsdoc工具包
- PDOC
- 自然文档
- docco
- YUI文档
- doctool http://jquery.bassistance.de/docTool/docTool.html
- 其他?
要求
- 应该使用jQuery,下划线和主干。 这意味着对象文字方法等
- 我真的很喜欢pdoc,但是它太过于以原型为中心,没有很好的文档logging,而且我不想制作额外的文件(部分?)来使其工作(不确定这一点)
- docco是不错的,但我想要结构化的输出(如菜单+ class / func结构像jdoc)
- 必须是命令行/制作文件兼容(不是网上的贴图)
提示,技巧,教程,成功的故事,build议非常欢迎。
为什么不jQuery使用JSDoc?
我会评价jsduck从Sencha顶部。 我在很多项目上都使用过它。 简单易用
https://github.com/senchalabs/jsduck
一个命令将生成像这样的文档http://docs.sencha.com/touch/2-0/
你也可以看TJ Holowaychuk的Dox ; 这是Docco的一个分支,但增加了一些jsDoc语法支持。 我个人发现,jQuery代码经常适用于像Docco这样的内联文档,但我目前处于试图决定使用什么doc系统的相同情况。
目前我正在进行同样的练习,从我看到的YUI Doc是最好的。 我喜欢这样一个事实,即你可以在“服务器”模式下运行它,并在编写文档时查看文档。 比每次更改文档时都必须执行构build要好得多。 而且,生成的文档非常易于阅读,组织得非常好。
这是新的,所以它可能不符合你的输出要求,但你可能会发现njsdoc有趣。 与大多数JS文档不同,它试图通过执行代码和调查堆栈来构build文档,而不仅仅是parsing注释文件。
有DocumentJS *
*我没有使用它,我不知道它将如何与骨干整合。