Как использовать Rails или Ruby документацию?

Question

Я пришел из C #, и недавно я начал писать некоторые приложения Ruby on Rails.

Моя самая большая проблема - документация, потому что я нахожу ее чрезвычайно сложной в использовании. Например, выяснение того, как вызвать генератор из моего контроллера, заняло у меня около 2 часов, а затем через 15 минут я нашел метод Rails::Generators.invoke, чтобы выяснить, какие аргументы я должен передать этой функции.

Возможно, я неправильно использую документацию; Сначала я делаю неуверенное предположение и выполняю поиск по завершению кода Netbeans, что редко бывает полезно, затем я выполняю поиск в Google, а затем использую API.

Может ли какой-нибудь опытный программист на Rails дать мне совет?

Answer 1

Если вы новичок в рельсах, я рекомендую вам прочитать книгу, прежде чем погрузиться в документацию по API.

Вот две рекомендации:

• Agile Web Development с Rails - Отличное введение и справочник по использованию rails.
• Программирование на Ruby 1.9: Прагматическое руководство для программистов - Подробнее о Ruby. Отличные ссылки!

После того, как вы разберетесь с этими книгами, у вас будет представление о том, как спроектирован Rails и где искать вещи.

Обе книги - отличные справочники. Если вы хотите получить доступ к Rails и Ruby API онлайн, обязательно оформите RailsApi.com

Answer 2

Я описываю свой личный рабочий процесс с документацией по Ruby / Rails:

1. Вы можете использовать ri и rdoc, если вы знакомы с консолью, но ...

2. Лично я рекомендую два очень хороших сайта документации по Ruby / Rails:

   • apidock.com (нет хорошего поиска, но иногда хорошие примеры)
   • railsapi.com (очень хороший поиск AJAX, плюс вы можете настроить, какую документацию вы хотели бы видеть - по версиям и Gems)

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.

Я проголосовал за все остальные ответы здесь.