生成Javascript文档

Question

我正在寻找一种从我的Javascript项目自动生成文档的方法.谁知道我怎么能这样做？

据我所知,有一些工具,如JSDoc,但我想知道你的意见,你最好的选择和原因.

谢谢!

编辑:为了清楚,我需要像JavaDOC或PHPDocumentor,但要使用我的Javascript源代码.

Answer 1

有像Natural Docs这样的工具可以做到这一点.我个人过去曾经使用它,这可以正常使用javascript.

还有像docco这样的工具来记录源代码.

通常,自动生成的文档往往限制性太强,有时像jQuery API这样的手工API更容易使用.

动态语言的文档也与静态语言的文档不同.由于API的使用方式不同而且状态存在于更松散的意义上.

Answer 2

我找到了一个使用JSDoc创建JS文档的好教程.我希望对需要它的人有所帮助.

这正是我所需要的.谢谢你的答案堆叠器.

Answer 3

如果你使用node.js,我创建了一个模块,为javascript/node/html/css生成类图.它基于UML的"WAE"扩展.它叫做wavi.对于javascript,自动识别其他模块的功能,变量和使用.您可以使用它来记录您的应用程序.

由wavi生成的图