假设我正在编写一些 ruby 代码,并且我想使用标准 Date 类型来获取当前日期。除了使用搜索引擎,有没有更快的方法来找到这个类的文档?我知道我可以通过键入来获取 Date 的方法Date.methods
,但据我所知,这并没有提供有关参数类型或返回值的详细信息。
欢迎编辑特定的答案。我选择的编辑器是 Emacs。
假设我正在编写一些 ruby 代码,并且我想使用标准 Date 类型来获取当前日期。除了使用搜索引擎,有没有更快的方法来找到这个类的文档?我知道我可以通过键入来获取 Date 的方法Date.methods
,但据我所知,这并没有提供有关参数类型或返回值的详细信息。
欢迎编辑特定的答案。我选择的编辑器是 Emacs。
使用您的网络浏览器的查找文本命令。
看起来可能出乎意料,我发现这实际上比 using 更快ri
,由于某种原因,这似乎需要很长时间才能启动。
这也比ri
HTML 页面在单个页面上列出所有方法的所有文档要好得多。通常方法与其他方法相关,在 2 之间切换ri
很痛苦
在您的控制台上使用“ri”
ri Date
这适用于所有课程。(例如 ri 字符串)要查看特定方法的文档,请使用以下命令:
ri Date#yourMethod
Ruby 文档的规范来源是Ruby-doc - 其中最受关注的两个链接是core和standard library。你会得到一个 javadoc 样式的表示,它通常涵盖参数类型和返回值。您甚至可以使用RDoc自己制作。
对于那些想要从香草 IRB 中获取文档的人
按照这些说明设置核心 RI 文档。在撰写本文时,步骤是
$ cd ~/.rvm/src
$ rvm docs generate-ri
现在,您可以使用该命令在命令行上查看特定方法的文档ri
。要从 IRB 中调用它,请使用帮助命令:
$ irb
irb(main):001:0> help 'String#chomp'