Ruby核心文档质量

我对Ruby比较陌生，时间有限，所以我会尝试一些简单的事情。 最近我需要创建一个文件，因为我懒得要命，我跑去谷歌。结果是：

File.open(local_filename, 'w') {|f| f.write(doc) }

我真丢脸，这很直截了当，应该自己做的。然后我想检查ruby-magic文件类的方法提供了什么，或者在调用这些方法时是否有任何“简化”，所以我开始阅读文档，检查文件类

• 1.8.6文档向我展示了“File”类下的“ftools.rb：文件类的额外工具”，这不是我想要的
• 1.8.7对于“文件”类来说，文档似乎还可以，但有过多的方法。除了“开放”
• 1.9文档最终向我展示了“开放”方法

我和Net:：HTTP有着几乎相同的经历

当我认为旧的turbopascal的7.0文档比现在的Ruby文档组织得更好时，我是否夸大了这一点？没有经验的人是否有其他来源来收集知识？或者有没有可能我只是跌进了一个文档洞，其他的都是超棒的五星组织

---

感谢

您必须记住，Ruby是一种面向对象的语言，标准库中的许多对象都构建在其他对象之上。此外，许多应用程序还通过模块进行了扩展，增加了新的功能

因此，在文档中，您需要了解对象是基于什么构建的。在File的例子中，它是构建在的基础上的，它将具有许多在标准“File”类中可以找到的功能

我同意Ruby的一些文档是不连贯的。我认为买一本好书很重要；我推荐一本我们称之为“鹤嘴锄书”的书，又名“鹤嘴锄书”。还有许多其他的好书，以及一些在线的好文档，但这是一本非常棒的书。[第一版]在网上免费提供；它有点过时，但仍然有用

我建议您浏览一下，以便获得更多建议

我还保持对Ruby 1.9和文档的链接。最后，最重要的一点是很多好的信息，尽管你必须注意文档的版本

最后，不要忽略内置的帮助：

ri

在命令行中是您自己机器上的快速信息源，应该包含核心和标准库的文档，以及您安装的所有gems

ri open

会告诉你所有“open”的位置都被定义了

ri File.open

将为您提供有关该命令的大量信息

---

当我开始使用Ruby时，学习该语言的最大障碍是文档。我仍然觉得获取和的信息要容易得多，并且觉得Ruby应该用这些作为例子。但这并没有改变我使用Ruby的乐趣。这是一门很棒的语言，一旦克服了最初的困难，我就越来越喜欢它了

---

@福弗在上面的评论中建议。我没看过那个网站，但看起来不错。我喜欢它清楚地显示了类继承的内容

没错，1.9之前的文档中有一个关于

文件#open

的bug

在

Kernel

下有一个

open

文档，是的，您实际上可以说

File.open

正如您所指出的，它既不在

文件中也不在
IO
中

我的建议是…
我目前的版本是ruby 2.0.0和ri 4.0.1（ri-v）。我一直遇到同样的问题，我键入ri File.open=>“对File.open一无所知”

在网上搜索后，我发现了这个代码

该页面也是一个很好的阅读，为什么你应该使用ri而不是谷歌

编辑：该代码修复了“关于File.open一无所知”的问题。安装需要一些时间，因此需要打开一个新选项卡。
使用Ruby（以及Ruby on Rails），您必须知道要查找什么。我同意这两个网站的在线文档可能会更好！就个人而言，我几乎总是去而不是ruby-doc.org。我发现它更容易浏览，而且它还可以（根据要求）生成gems文档。我也很懒。@phoffer+1代表rubydoc.info。我没有遇到过那个网站。谢谢你对rubydoc.info网站的建议，它太棒了。如果我第一次去那里，我就不会写这个问题了。哈哈。这是个好问题。也许如果我们中的一些人在rubydoc.info上投入一些志愿者的时间，我们可以让它成为Ruby的核心文档站点。我认为它有很大的潜力。这个答案可以改进。事实上，直到1.9版本，文件open才出现在Ruby的文档中。如果他接受了你的建议并查看IO，那么1.9之前的版本他只会看到一个采用文件描述符的开放例程。内核下有一个基于文件名的开放文档，但这是另一个故事。指向1.9 IO之前的版本说明了文档需要组织和清理的OPs点。我刚刚意识到我遗漏了问题中最重要的信息。我目前使用的是“ruby 1.8.7（2010-06-23 patchlevel 299）[i686 linux]”，这是最新的Ubuntu 10.10 ruby版本“ri File.open”生成“关于File.open一无所知”，通过快速比较，我发现“ri”显示给我的文档与1.8.7文档相同。是的，唉，这是一种不幸的状况。我建议您使用
gem rdoc --all --ri --no-rdoc