我是不是因为没有为 gems 安装 ri 和 rdoc 而错过了啥？

Posted 2023-03-16

【中文标题】我是不是因为没有为 gems 安装 ri 和 rdoc 而错过了啥？

【英文标题】：Am I missing something by not installing ri and rdoc for gems?我是否因为没有为 gems 安装 ri 和 rdoc 而错过了什么？

【发布时间】：2010-12-25 14:55:34

【问题描述】：

我从未见过为 gems 安装 ri 和 rdoc 的意义，我的 .gemrc 文件设置了 --no-ri 和 --no-rdoc。由于每个 gem 都包含 ri 和 rdoc 信息，我只是想知道我是否遗漏了什么？为 gem 安装 ri 和 rdoc 有什么好处吗？

谢谢

克里斯

总结

如果您不安装 ri 和 rdoc，您不会失去任何有价值的东西。我想也许它已经在某些 IDE 中使用（我是 Emacs 用户），但似乎并非如此。

【参考方案1】：

安装 ri 文档的目的很简单，就是您可以使用“ri”命令逐个方法访问文档。例如，尝试：“ri String#reverse”。按“q”退出。

要试用 RDoc 文档，请运行“gem server”，然后在浏览器中连接到 localhost:8808。我觉得它很有用——您甚至可以单击方法名称来查看源代码。当然，你可以直接进入你的 gems 文件夹并打开 doc 文件夹中的 html 文件。

访问 RDoc 的另一种方法是 gemdoc 命令。见http://www.stephencelis.com/2008/06/12/bashfully-yours-gem-shortcuts.html。这很方便，恕我直言。

不管怎样，你可以偷懒，等到需要 RDoc 文档，然后用“gem rdoc”生成它。

【讨论】：

感谢您提及 gem 服务器

【参考方案2】：

就我个人而言，我也在安装没有 rdoc 和 ri 的 gems，因为通常你也可以在 Internet 上找到所需的所有文档（即 www.rdoc.info），因此无需投资硬盘一代人所需要的空间和时间

【参考方案3】：

如果您想要本地可用的 gem 文档，请安装它。

【讨论】：

那么真的没有遗漏任何东西。

【参考方案4】：

这篇文章很好地说明了使用 ri 的原因和方法：

http://jstorimer.com/ri.html

该列表中的最佳点是#1：ri 了解 Ruby。例如：

$ ri ActiveRecord::Base#save
(from gem activerecord-3.2.8)
Implementation from ActiveRecord::Persistence

[...]

(from gem activerecord-3.2.8)
Implementation from ActiveRecord::Validations

[...]

请注意，即使不是直接在 ActiveRecord::Base 本身上也可以找到该方法。