ruby - 我如何理解 Ruby 文档？

标签 ruby

<分区>

我见过这样的代码:

Net::HTTP::Post.new(url)

如果我然后按如下方式使用 ri:

$ ri Net::HTTP::Post

我几乎没有得到任何文档，并且:

$ ri Net::HTTP::Post.new

结果

Nothing known about Net::HTTP::Post.new

阅读 Net::HTTP 的文档时，我怀疑代码应该使用 Net::HTTP#request_post。我仍然觉得使用这个模块的正确方法令人困惑。为什么 Net::HTTP::Post.net 似乎有效？即使使用 Net::HTTP.request_post，我也得到:

undefined method `request_post' for Net::HTTP:Class.

为了澄清我的问题，我想知道如何:

相比之下，这是 Python 的等效文档，据我所知(我自己是 Python 开发人员):http://docs.python.org/2/library/httplib.html

最佳答案

这是我最终会接受的答案，除非其他人有更好的答案:

为了理解 Ruby 的文档，请按顺序执行以下操作:

阅读现有最新版本 Ruby 中模块的文档。使用 ruby-doc.org，即使此版本适用于 Ruby 2.0 而您使用的是 Ruby 1.8，它仍然可能更加清晰和完整。
使用谷歌查找代码示例。
使用 irb 检查示例是否真正有效。
使用 ri 检查您的 ruby 版本的文档是否存在。如果存在，请查看有关您的版本可能有何不同的任何见解。
使用反射/内省(introspection)来尝试发现任何可能有用的公开方法。

关于ruby - 我如何理解 Ruby 文档？，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/19260885/

相关文章：

c - 从 Gem 覆盖 Ruby 的基本 C 代码