是否有工具从CommonJS或node.JS模块中提取文档/注释？

Question

例如：

/** This is my foo method, it's great. */
exports.foo = function(a, b) {
    return a + b;
};

拥有扫描.js源目录并构建文档，列出每个模块的方法及其相关描述注释，可能是整个模块的概述注释，以及查找{{1调用以显示模块之间的依赖关系。

Answer 1

今晚我写了this tiny tool。 它允许您构建something like this 使用this code作为来源。

它不是功能齐全的jsdoc解析器，我认为所有这些功能完全糟糕，因为生成的文档太垃圾，充斥着不必要的结构。

我的工具构建的平面代码看起来像一本书，而不像深树。

Answer 2

你应该真正研究docco。它旨在执行您正在描述的“文字编程”风格文档，并从中生成非常好的外观文档。

顺便说一句，我链接到你的页面是docco解析本身。