2011-05-02 49 views
2

我在ruby-doc上导航RDoc信息时遇到了一些问题。现在可能只是我,来自java世界,但我错过了什么?绕过红宝石api

例如,当我想要执行File IO时,我查找File并找到相应的页面。在那里,我看到了所有在File上的静态方法。那很完美。我在这里没有找到的是实际的实例方法,如fileInstance.read_line,我实际上通过做一个投入fileInstance.methods

发现那些我想优化我的工作流程,我相信我会深入研究红宝石api在未来几周内有很多,所以我在这里错过了什么?我在哪里可以找到api中的read_line示例?

谢谢

+0

您可能会发现[railsapi.com](http://railsapi.com/doc/ruby-v1.9.2/)有用。就我个人而言,我发现Ruby(和Rails)“官方文档站点”笨重。 – Zabba 2011-05-02 06:47:19

+0

是! railsapi.com使用SDOC(或可搜索的rDOC)。 rubydoc.info具有与YARD相同的功能,但railsapi.com允许您同时搜索方法和类。失败的是,你无法单独搜索项目的SDOC返回到主页面,点击“构建你的定制软件包”,并选择(有限)数量的库进行搜索。 – RyanScottLewis 2011-05-02 06:52:36

回答

6

尝试http://rubydoc.info/stdlib/core/1.9.2/frames

而且,印刷之类的东西my_instance.methods.sort一个很好的办法是:

# Require the pp library... 
# which just breaks long outputs into multiple lines. 
require 'pp' 

pp Object.new.methods.sort 
对眼睛

容易得多。

其他小提示:

  • 我们使用underscores_for_methods_and_vars,没有驼峰。
  • pputs是不同的。参见:p vs puts in Ruby

快乐编码!

+0

好了,它清楚地显示了read_lines作为从IO继承的方法,谢谢 – npiv 2011-05-02 06:40:54

+0

YARD比rdoc好多了。我从来不明白为什么rdoc不能包含mixins和父类的方法。 – juan2raid 2011-05-02 06:41:01

+1

如果他们将YARD添加到stdlib,我不会失眠。 – RyanScottLewis 2011-05-02 06:42:35