如何使用Rails或Ruby文档？

Question

我来自C＃，最近我开始编写一些Ruby on Rails应用程序。

我最大的问题是文档，因为我发现它极难使用。例如，找出如何从我的控制器调用生成器花了我大约2个小时，然后15分钟后我找到Rails::Generators.invoke方法来弄清楚我应该传递给这个函数的参数。

也许我以错误的方式使用文档;首先，我猜测并搜索Netbeans代码完成，这很少有用，然后我在Google中搜索，然后使用API​​。

一些经验丰富的Rails程序员可以给我一些建议吗？

Answer 1

如果您是初次使用rails，我建议您在深入了解API文档之前先阅读一本书。

以下是两条建议：

• Agile Web Development With Rails - 关于如何使用rails的详细介绍和参考。
• Programming Ruby 1.9: The Pragmatic Programmers' Guide - 有关Ruby的更多信息。很棒的参考！

在您完成这些书籍之后，您将了解Rails的设计方式以及在哪里寻找内容。

这两本书都是很好的参考书。如果您想在线访问Rails和Ruby API，请务必结帐RailsApi.com

Answer 2

我正在使用Ruby / Rails文档描述我自己的个人工作流程：

1. 如果您熟悉控制台，可以使用ri和rdoc，但是......

2. 就个人而言，我推荐两个非常好的Ruby / Rails文档站点：

   • apidock.com（没有好的搜索，但有时很好的例子）
   • railsapi.com（非常好的AJAX搜索，你可以根据版本和宝石自定义你想看的文件）

Answer 3

Rails指南的每次迭代（http://guides.rubyonrails.org/）都有很多有用的东西。那应该是第一站。

之后我在API中搜索 - http://api.rubyonrails.org。

有时我甚至会在阅读源代码时尝试查找内容 - https://github.com/rails/rails。

我认为要阅读的源代码中最好的地方就在这里 - https://github.com/rails/rails/tree/master/railties/lib/rails。

我在这里赞成了其他每个答案。