node.js模块API文档如pydoc?

时间:2011-05-09 06:46:31

标签: api documentation node.js

是否有任何库或二进制文件可以像pydoc一样处理已安装的node_modules? 每次检查每个模块或js文件的API使用情况真的很烦我。

由于node.js已经为我们提供了良好的检查功能,我相信必须完成一些工作或者至少要记录已安装的node_modules,但我找不到任何东西。

任何人都可以指导我吗?

2 个答案:

答案 0 :(得分:3)

没有设置任何内容,因为模块中没有任何标准化的注释来解析文档。

最好你可以解析对象并找到你可以调用的所有方法,包括参数的名称,但这不是非常有用的信息。

我担心您将不得不继续阅读模块供应商发布的在线API。

答案 1 :(得分:2)

结帐:Documenting Node.js projects

它讨论了如何使用docco来注释源代码。