Ruby文档之RDoc和ri的详细介绍
Ruby文档之RDoc和ri的详细介绍
有点像java的api文档,ruby也有了自己的html api文档。除了可以以html的方式查看ruby的文档外,
ruby还提供了另外的一种方式。
进入shell prompt,键入 ri ** (**是要查的类)
例如键入 ri GC ,显示如下:
---------------------------------------------------------Class:GC
The GC module provides an interface to Ruby's mark and sweep
garbage collection mechanism. Some of the underlying methods are
also available via the ObjectSpace module.
-----------------------------------------------------------------
Class methods:
disable, enable, start
Instance methods:
garbage_collect
此外,还可以键入要查的方法名等,如果有多个这样的方法名,shell prompt会列出所有的方法名供我们
选择。
要查一个类内嵌的类和模块等,可以用::符号,如要查类A内嵌的类B,可以键入
ri A::B
而如果要一个类里面的方法和变量,用.点号代替::即可。
如果想知道ri 的其他功能和查询方式,键入ri -help即可。