Ruby相当于Python的帮助()？

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

现在是 2014 年底，这里有两种获得 Python help()*相似性的方法，只要您安装了Ruby Docs：

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 2

尝试从命令行使用ri.

它将类名,方法或模块作为参数,并为您提供适当的文档.许多流行的宝石也带有这种形式的文档,因此它通常应该超出核心Ruby模块的范围.

Answer 3

对于iPython的帮助来说,这绝对是一个可怜的表兄弟,也是我转移到Ruby之后想念的主要功能之一,但你也可以ri从内部使用irb.我推荐使用wirble gem作为设置它的简单方法.