API文档生成工具

3

我有一个使用RubyOnRails(restfulie gem)编写的RESTful API。 从项目源代码生成API文档的最佳方法是什么?

2个回答

3

rake doc:app 命令可以将您的方法的 rdoc 格式注释转换为适当格式的 html。


1

idlefingers说得没错,但是这里是完整的答案,适合新手:

  1. 在你的Gemfile中添加rdoc:gem "rdoc"
  2. 运行$ rake doc:app生成文档
  3. 通过在浏览器中打开doc/app/index.html文件来访问rdoc

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接