简单的 JavaScript 文档生成器。
====================================================================================== 警告:JSDuck 已不再维护! - 如果您正在寻找一个文档工具,请尝试其他工具。 - 如果您正在使用 JSDuck,请考虑转用其他工具。 - 即使是 Sencha 本身也不再使用它,他们使用的是一些内部工具,这些工具并不公开提供。 - 如果您想接管 JSDuck 的维护工作,请通过创建一个问题与我联系。
JSDuck 旨在成为 [Ext JS][] 的更好的文档生成器,比旧的 [ext-doc][] 更好。它被 Sencha 用于文档 [Ext JS 4][ext4-docs]、[Sencha Touch][touch2-docs] 和 [其他几个][other-docs] 产品。 JSDuck 的亮点是支持 [Markdown][] 以及通过从代码中推断大量信息来保持干净。请阅读 [文档][] 了解完整概述。 新用户请查看 Nick Poulden 的 [介绍性演讲][video]:
使用标准的 rubygems 安装应用程序:
对于最简单的测试运行,只需使用 --builtin-classes 选项,将 JavaScript 类库中的类(如 Array、String 和 Object)的文档写入 docs 目录:
[][video] [Ext JS]: http://www.sencha.com/products/js/ [ext-doc]: http://code.google.com/p/ext-doc/ [Markdown]: http://daringfireball.net/projects/markdown/ [ext4-docs]: http://docs.sencha.com/extjs/ [touch2-docs]: http://docs.sencha.com/touch/ [other-docs]: http://docs.sencha.com/ [documentation]: https://github.com/senchalabs/jsduck/wiki [video]: http://vimeo.com/33465319 [winbin]: https://github.com/senchalabs/jsduck/releases [installation guide]: https://github.com/senchalabs/jsduck/wiki/Installation
暂无开放 Issues,或尚未同步最近议题。