ri and RDoc | DouO's Note

ri (Ruby Index) RDoc(Ruby Documentation)

ri 是查询文档的命令行工具，rdoc是生成文档的命令行工具。

ri Hash 可以会提示

Nothing known about Hash

需要更新数据包

gem install rdoc-data

# Regenerate system docs
rdoc-data --install

# Regenerate all gem docs
gem rdoc --all --overwrite

如果只是缺少一部分文档，可以尝试下面的命令

gem rdoc --all --ri --no-rdoc

如果使用 rvm 可以尝试

rvm docs generate all

通过下面的命令来查询文档

$ ri File
$ ri Fil
$ ri File.directory?
$ ri Socket#accept
$ ri ActiveRecord::Base.touch

ri -i 交互模式比较好用。

ri 的 emacs 插件: yari.el