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

StackOverflow https://stackoverflow.com/questions/3643904

  •  30-09-2019
  •  | 
  •  

Вопрос

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

Это было полезно?

Решение

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

RDOC также предоставляет двигатель для создания файлов данных RUBY RI. Ri - это (более или менее) версия MAN страниц Ruby, обслуживающая информацию API из командной строки.

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

Другие советы

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

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

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

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

Счетчик < Объект

= Включает в себя:Перечислимый (из ядра ruby)

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

Перечислитель может быть создан следующими методами.* Ядро#to_enum * Kernel#enum_for * Счетчик.новый

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

перечислитель = %w(один, два, три).каждый ставит enumerator.class # => Перечислитель enumerator.each_with_object("foo") do |item,obj| помещает "#{obj}:#{элемент}" конец # foo:один # foo:два # foo:три enum_with_obj = перечислитель.each_with_object("foo") помещает enum_with_obj.class # => Перечислитель enum_with_obj.каждое действие |item,obj| помещает "#{obj:#{элемент}" конец # foo:один # foo:два # foo:три

Это позволяет вам объединять счетчики в цепочку........

Лицензировано под: CC-BY-SA с атрибуция
Не связан с StackOverflow
scroll top