Ruby核心文档质量

kar*_*dog 10 ruby documentation

我对Ruby比较陌生,时间有限,因此我尝试了简单的事情.最近我需要创建一个文件,因为我很懒,我跑到谷歌.结果:

File.open(local_filename, 'w') {|f| f.write(doc) }
Run Code Online (Sandbox Code Playgroud)

对我感到羞耻,这很简单,应该自己做.然后我想检查File类的方法提供什么ruby魔法,或者在调用这些方法时是否有任何'简化',所以我在这里找到文档,并检查File类.

  • 1.8.6文档向我提供了"文件"类下的"ftools.rb:File类的额外工具",这不是我想要的.
  • 对于'File'类,1.8.7文档似乎没问题,有很多方法.除了'开放'.
  • 1.9文档最后向我展示了'开放'方法.

我和Net :: HTTP进行了几乎相同的巡演.

当我认为好的旧Turbo Pascal的7.0文档比Ruby文档更好地组织时,我是否夸大了?是否还有其他来源不知情的人会收集知识?或者我是否有可能陷入文件漏洞,其余的都是超级精彩的五星组织的?

谢谢

the*_*Man 5

您必须记住,Ruby是一种面向对象的语言,标准库中的许多对象都是基于其他对象构建的.此外,许多模块扩展了,增加了新的功能.

因此,在文档中,您需要查看构建Object的内容.在File的情况下,它建立在IO之上,它将具有您期望在标准"文件"类中找到的许多功能.

我同意Ruby的一些文档是脱节的.我认为获得一本好书很重要; 我推荐我们称之为"The Pickaxe Book",AKA" Programming Ruby ".还有许多其他好书,以及一些在线的好文档,但这是一本很棒的书.[第一版]可在线免费获取; 它有点过时但仍然有用.

我建议浏览一些与 SO 类似的其他问题,以获得更多建议.

我还保持对Ruby 1.9的CoreKeyword文档的链接.最后,Ruby-Docs网站的顶部指向了很多好的信息,但你必须注意文档的版本.

最后,不要忽略内置帮助:ri命令行是您自己计算机上的快速信息源,应包含核心和标准库的文档,以及您已安装的所有gem.ri open会告诉你所有"开放"的地方都被定义了.ri File.open会给你很多关于那个命令的信息.


当我开始使用Ruby时,学习该语言的最大障碍是文档.我仍然发现获取有关PerlPython的信息要容易得多,并且觉得Ruby应该使用这些作为示例.但这并没有改变我使用Ruby的乐趣.这是一种很棒的语言,一旦越过最初的驼峰,我越来越喜欢它.

@phoffer 在上面的评论中推荐RubyDoc.info.我没有看到那个网站,但它看起来不错.我喜欢它,它显示了一个类清楚地继承了什么.