用好ri，輕鬆查閱ruby/rails文件
阿新 • • 發佈：2019-01-12
RI是ruby中的一個文件查閱工具，類似於unix中的man的作用，可以用它查閱ruby中用rdoc格式書寫的類和方法的說明文件。以前沒有用好ri，因為一開始使用時覺得ri查出來的東西總是不全，比如想查一下移動檔案的方法File.move卻總也得不到正確的File類的說明，反而是一些gem提供的File擴充套件的方法說明，於是只好把ruby的html形式的rdoc存在瀏覽器的書籤中，需要查閱時通過瀏覽器開啟相關頁面查詢，這樣的效率太低，又非常繁瑣，如果把RI用好，我們可以輕鬆找到所有需要查閱的類和方法的說明， 甚至包括rails的API說明。
第一條要點就是要正確安裝好ruby系統的基本類庫的rdoc文件，比如從原始碼編譯生成的話就要 'make install-doc'，如果是通過linux分發包安裝的，比如我使用的是gentoo, 那麼要確保USE中帶有doc變數。
一旦正確安裝好後，基本庫的類就能找到了。
第二條，如果安裝了rails，那麼可以用命令 gem rdoc --all 來生成所有的 gems 的rdoc。
使用ri時，需要記住"::"是類方法的分隔符，"#"是例項方法的分隔符，而"."是二者皆可的分隔符。
查詢類時要以大寫字母開始，查詢方法則以小寫字母開始。例如：
ri File # 查詢類File
ri move # 查詢方法move
注意如果方法名中含有符號，需要用引號括起來，或者進行轉義:
ri 'Array.[]'
ri compact/!
預設情況下ri按照下面的順序搜尋文件：
/usr/share/ri/1.8/system
/usr/share/ri/1.8/site
/home/yangbo/.rdoc
/usr/lib/ruby/gems/1.8/doc/*/ri
第一條要點就是要正確安裝好ruby系統的基本類庫的rdoc文件，比如從原始碼編譯生成的話就要 'make install-doc'，如果是通過linux分發包安裝的，比如我使用的是gentoo, 那麼要確保USE中帶有doc變數。
一旦正確安裝好後，基本庫的類就能找到了。
第二條，如果安裝了rails，那麼可以用命令 gem rdoc --all 來生成所有的 gems 的rdoc。
使用ri時，需要記住"::"是類方法的分隔符，"#"是例項方法的分隔符，而"."是二者皆可的分隔符。
查詢類時要以大寫字母開始，查詢方法則以小寫字母開始。例如：
ri File # 查詢類File
ri move # 查詢方法move
注意如果方法名中含有符號，需要用引號括起來，或者進行轉義:
ri 'Array.[]'
ri compact/!
預設情況下ri按照下面的順序搜尋文件：
/usr/share/ri/1.8/system
/usr/share/ri/1.8/site
/home/yangbo/.rdoc
/usr/lib/ruby/gems/1.8/doc/*/ri