В чем разница между ri и rdoc

Question

Всякий раз, когда я устанавливаю драгоценные камни, я вижу ri и rdoc. Я знаю, что это документация, но в чем разница между ними и как их использовать?

Answer 1

RDoc [..] - встроенный генератор документации для языка программирования Ruby. [..] RDoc включен как часть дистрибутива ядра Ruby.

RDoc также предоставляет механизм для создания файлов данных Ruby ri. ri - это (более или менее) версия Ruby версии man-страниц, обслуживающая информацию API из командной строки.

От: http://en.wikipedia.org/wiki/RDoc

Answer 2

• RDoc автоматически генерирует документацию из комментариев и структуру кода. https://github.com/rdoc/rdoc Так думаю Doxygen. Используйте его для создания автоматической документации для написанного кода.
• ri - это файлы справки, например, если у вас нет интернета. http://www.caliban.org/ruby/rubyguide.shtml#ri Think perldoc. Используйте его, когда у вас есть вопрос о классе, как ri Enumerator должны воспитывать

Enumerator < Объект

---

= Включает: перечислимых (от рубинового ядра)

(из рубина ядро) ----------------------------------------------- ------------------------------- Класс, который позволяет как внутреннюю, так и внешнюю итерацию.

Перечислитель может быть создан следующими методами. * Ядро # to_enum * Ядро # enum_for * Enumerator.new

Большинство методов имеют две формы: блок-формы, где содержимое оцененную для каждого элемента в перечислении, а также формы не-блок, который возвращает новый Enumerator, завершающий итерацию.

enumerator =% w (один два три) .each puts перечислитель.класса # => Enumerator enumerator.each_with_object ("foo") do | item, obj | puts "# {obj}: # {item}" end # foo: one # foo: two # foo: three enum_with_obj = enumerator.each_with_object ("foo") помещает enum_with_obj.class # => Enumerator enum_with_obj.each do | вещь, OBJ | пут "# {OBJ: # {пункт}" конец # Foo: один # Foo: два # Foo: три

Это позволяет цепь счетчикам вместе ........

Answer 3

Чтобы получить доступ к локальному RDoc для ваших драгоценных камней, введите gem server и укажите свой браузер на http://localhost:8808.

Если RDocs для ваших драгоценных камней не установлен, gem rdoc --all установит документацию для всех ваших драгоценных камней.

Может показаться, что местная документация не требуется. Многие разработчики целенаправленно пропускают установку в пользу онлайн-документации.Однако для тех из нас, кто использует устаревшие инструменты, такие как Rails 2, он может легко и быстро найти правильную документацию.