使用ri查看Rails的API

我一直都比较习惯直接到 http://www.ruby-doc.org/core/ 查看Ruby的各种API和到http://api.rubyonrails.org/ 查Rails的API.

其实安装ruby和rails后,在本机就已经有了这些文档,当然是在安装的时候安装了相应的rdoc的前提下.直接就可以使用 ri 来查看ruby和rails的文档.

ruby的API可直接查看,如:ri Date.

如果想要使用 ri 查看rails的文档,还要做执行一下: gem rdoc rails,还可以使用 -v 选项指定版本号,假如安装了多个rails版本,如: gem rdoc rails -v 2.3.2

懒的话,可以用 gem rdoc --all 一次把安装了的gem全部都生成rdoc.

使用 ri 查看文档,方便简单.

评论

3 楼 yangzhihuan 2009-03-27  

rainux 写道

Ruby 自己的 ri 太慢，装个 fastri 就爽多了。

# 为了方便可以直接 gem 安装，但根据文档手动用 tarball 安装性能会更高
sudo gem install fastri
# 生成索引
fastri-server -b

以后在命令行里就可以用 qri 替代 ri 了。

果然比ruby自带的ri要快不少,而且文档还显示彩色,哈哈...好用,多谢推荐.

2 楼 rainux 2009-03-26  

Ruby 自己的 ri 太慢，装个 fastri 就爽多了。

# 为了方便可以直接 gem 安装，但根据文档手动用 tarball 安装性能会更高
sudo gem install fastri
# 生成索引
fastri-server -b

以后在命令行里就可以用 qri 替代 ri 了。

1 楼 Arbow 2009-03-26  

跟man一样方便的阿，赞