18、Ruby on Rails开发实用技巧：文档生成、数据渲染、调试与PDF生成

Ruby on Rails开发实用技巧：文档生成、数据渲染、调试与PDF生成

1. 为应用程序生成文档

在Ruby开发中，RDoc是一个强大的文档系统。以下是使用RDoc为应用程序及其依赖项生成和浏览文档的方法：
- Rails文档 ：
- 如果你使用RubyGems安装了Rails，可以使用 gem server 命令来访问所有已安装Rails版本（以及系统上的其他gem）的文档。运行 gem server 后，在浏览器中访问 http://localhost:8808 。若要指定端口，可使用 -p 选项，如 gem server -p 2600 。在页面上会列出所有已安装的gem，点击即可浏览其文档。
- 使用内置的Rake任务 doc:rails ，可以为应用程序使用的特定版本的Rails生成本地可访问的文档，生成的HTML文件将存放在 doc/api 目录中。如果需要，还可以通过设置 template 环境变量来更改RDoc模板。
- Rails指南 ：Rails团队维护了一套有用的框架指南，通常可通过 http://guides.rubyonrails.org 访问。若需要本地副本，可使用 rake docs:guides 生成，生成的指南将存放在Rails应用程序的 doc/guide