API文档生成工具

Question

我有一个用Ruby On Rails编写的RESTful API（restful gem）。 从项目源生成api文档的最佳方法是什么？

Answer 1

rake doc:app会将您方法的rdoc格式化注释转换为格式正确的html

Answer 2

idlefingers没错，但这是新手的完整答案：

1. 在您的Gemfile中包含rdoc：gem“rdoc”
2. 运行$ rake doc：app以生成文档
3. 通过在浏览器中打开doc / app / index.html文件来访问rdoc