Ruby中相当于Python的help()的是什么？

Question

在使用交互式Python的时候，我通常会依赖内置的 help() 函数来告诉我某个东西需要什么，或者返回什么，并打印出可能对我有帮助的文档。请问在Ruby中有没有类似的功能呢？

我想找一个可以在irb中使用的工具。例如，在交互式Python中，我可以输入：

>>> help(1)

然后它会打印出

Help on int object:

class int(object)  |  int(x[, base])
-> integer  |    |  

Convert a string or number to an integer, if possible. A ...

Answer 1

如果你想快速查看 Ruby 的文档，可以在命令行中输入 ri，后面跟上你想了解的方法名。

比如说：

ri puts

记得要在命令行中输入这个，而不是在 irb（交互式 Ruby 环境）里。

如果你已经在 irb 环境中，可以用另一种方法，就是输入 help，后面跟上你想了解的方法名，像这样：

help puts

不过，这样做前提是你已经正确设置了 Ruby 环境，让 help 能在 irb 中正常工作。我通常会打开另一个命令行窗口，直接用 ri 来快速查看某个方法或方法参数的用法，这样更方便。

Answer 2

现在是2014年末，这里有两种方法可以获取类似Python中help()的功能，只要你安装了Ruby文档：

1. 在irb环境中，你可以用一个字符串来调用help方法，描述你想要了解的内容。

   例子1：help 'Array' 用于获取Array类的信息
   例子2：help 'Array#each' 用于获取Array类中each方法的信息。

2. 在命令行中，不在 irb环境下，你可以使用ri程序：

   例子1：ri 'Array' 用于获取Array类的信息
   例子2：ri 'Array#each' 用于获取Array类中each方法的信息。

* 虽然不如Python的好，但总比没有强。

Answer 3

你也可以在 irb 里面使用 ri。我推荐使用 wirble gem，这样可以很简单地进行设置。