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

Try using ri from the command line.

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

Answer 2

对于iPython的帮助来说，这绝对是一个可怜的表兄弟，也是我转移到Ruby后我想念的主要功能之一，但你也可以在ri内使用irb。我建议wirble gem作为一种简单的方法进行设置。

Answer 3

现在已经到了2014年底了，只要您安装了Ruby Docs，就可以通过两种方式获得Python help() *相似性：

1. 从irb内部，您可以使用描述您正在寻找的内容的字符串调用help方法。

   示例1：数组类的help 'Array'
   示例2：help 'Array#each'类Array方法的each。

2. 从irb的命令行外，您可以使用ri程序：

   示例1：数组类的ri 'Array'
   示例2：ri 'Array#each'类Array方法的each。

*不如Python那么好，但仍然比没有好

Answer 4

应该是irb_help。但就像那篇文章中提到的那样，它在我的ruby安装中也被打破了。

Answer 5

要快速访问ruby文档，只需输入ri，然后输入您想要了解更多信息（从shell获取）的方法。

例如：

ri puts

这必须在你的shell中启动，而不是你的irb（交互式ruby环境）

如果您处于irb环境中，那么另一种方法是简单地键入help，然后输入您想要了解的方法，如下所示：

help puts

但是，这假设您已正确配置Ruby环境以使其（帮助）在irb中正常工作。我通常只打开另一个shell，当我对方法的某个方法或参数有疑问时，只需直接使用ri进行快速访问。