每当我安装 gems 时，我都会看到 ri 和 rdoc 紧随其后。我知道这是文档，但是两者之间有什么区别以及如何使用它们？
问问题
9388 次
3 回答
32
RDoc [..] 是 Ruby 编程语言的嵌入式文档生成器。[..] RDoc 包含在 Ruby 核心发行版中。
RDoc 还提供了用于创建 Ruby ri 数据文件的引擎。ri （或多或少）是 Ruby 版本的手册页，从命令行提供 API 信息。
于 2010-09-04T20:42:42.433 回答
21
要访问您的 gem 的本地 RDoc，请键入gem server并将浏览器指向http://localhost:8808.
如果您的 gem 的 RDocs 没有安装，gem rdoc --all将为您的所有 gem 安装文档。
似乎不需要本地文档。许多开发人员故意跳过安装它以支持在线文档。然而，对于我们这些使用像 Rails 2 这样的遗留工具的人来说，它可以让找到正确的文档变得又快又容易。
于 2013-02-28T19:05:27.490 回答
14
RDoc自动从代码的注释和结构生成文档。https://github.com/rdoc/rdoc所以想想 Doxygen。使用它为您编写的代码生成自动文档。ri是离线帮助文件，例如，如果您没有互联网。http://www.caliban.org/ruby/rubyguide.shtml#ri想想perldoc。当您对课程有疑问时使用它，例如ri Enumerator应该提出
枚举器 < 对象
= 包括：可枚举（来自 ruby 核心）
（来自红宝石核心） --------------------------------------------- --------------------------------- 允许内部和外部迭代的类。
可以通过以下方法创建 Enumerator。* 内核#to_enum * 内核#enum_for * Enumerator.new
大多数方法有两种形式：一种是对枚举中每个项目的内容进行评估的块形式，另一种是返回一个包装迭代的新 Enumerator 的非块形式。
enumerator = %w(一二三).each puts enumerator.class # => Enumerator enumerator.each_with_object("foo") do |item,obj| puts "#{obj}: #{item}" end # foo: 一 # foo: 二 # foo: 三 enum_with_obj = enumerator.each_with_object("foo") puts enum_with_obj.class # => Enumerator enum_with_obj.each do |item,对象| puts "#{obj: #{item}" end # foo: 一 # foo: 二 # foo: 三
这使您可以将枚举器链接在一起........
于 2013-02-26T22:49:53.403 回答