用好ri,轻松查阅ruby/rails文档

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
发布了46 篇原创文章 · 获赞 7 · 访问量 8万+

猜你喜欢

转载自blog.csdn.net/yangbo_hr/article/details/2026216