node.js – 通过代码注释生成API文档

我正在使用aglio来生成我的API文档.我目前正在根据API Blueprint规范为此编写原始markdown.我想知道是否有办法直接在代码中通过注释生成降价.有人知道这样做的方法吗？ 从技术上讲,它是可能的.取决于您的语言和使用的框架.例如,在 Ruby中,可以使用 RSpec to generate API Blueprint.

我不熟悉为Node.js做类似工作的任何工具(例如使用Express.js DSL).

在编写生成蓝图的工具时,可以避免手动编写蓝图并使用Matter Compiler.此工具(Ruby gem)将JSON或内存树(AST)转换为API蓝图.

请注意,我个人建议不要从代码生成文档.相反,我将API Blueprint视为可用于test your API implementation的合约.

在这个意义上,从代码生成蓝图就像从代码生成测试(以测试相同的代码).