获取Ruby文档的最快方法是什么？

Question

假设我正在编写一些ruby代码，我想使用标准的Date类型来获取当前日期。而不是使用搜索引擎，是否有更快的方法来查找此类的文档？我知道我可以通过键入Date.methods来获取Date的方法，但据我所知，这并不提供有关参数类型或返回值的详细信息。

欢迎编辑特定的答案。我的选择编辑是Emacs。

Answer 1

为ruby core docs

添加书签

使用网络浏览器的find-text命令。

看起来很意外，我发现这实际上比使用ri更快，因为某些原因似乎需要很长时间才能启动。

它也比ri好得多，因为HTML页面列出了单个页面上所有方法的所有文档。通常方法与其他方法相关，并且在2 ri之间切换是痛苦的

Answer 2

在您的控制台上使用“ri”

ri Date

适用于所有课程。 （例如ri String） 要查看特定方法的文档，请使用以下命令：

ri Date#yourMethod

Answer 3

Ruby文档的规范来源是Ruby-doc - 最感兴趣的两个链接是core和standard library。您将获得一个javadoc样式的表示形式，通常包含参数类型和返回值。您甚至可以使用RDoc制作自己的作品。

Answer 4

对于那些想要来自香草IRB的文档的人

1. 按照these说明设置核心RI文档。在撰写时，步骤是

   $ cd ~/.rvm/src
   $ rvm docs generate-ri
   

2. 现在，您可以使用ri命令在命令行上查看特定方法的文档。要从IRB中调用它，请使用help命令：

   $ irb
   irb(main):001:0> help 'String#chomp'