2011-11-10 26 views
3

什么是最好的Ruby文档资源?Ruby标准库的Unix手册页?如何Rails?

有些事情我在寻找:

  • 离线
  • 容易跟上最新
  • CLI支持和快速
  • 适合参考和浏览和学习新事物
  • Vim整合将会很好,但不是必需的
  • 如果它也覆盖Rails也会带来奖励

来自Unix上的C,我非常喜欢手册页的格式和界面。类似的东西会是理想的。

我喜欢类似的PHP文档。 http://php.net/foo我发现与man foo类似:预览大纲,以及更多信息,示例和指向相同页面上相关调用的链接。

到目前为止我发现的Ruby文档都是大框架的HTML网站,非常适合参考 - 我特别喜欢你如何挖掘到任何东西的源代码 - 但我不喜欢使用浏览器,我不觉得这些界面非常适合发现。

+0

我认为[RDoc的(http://en.wikipedia.org/wiki/RDoc)与它的命令行界面沿靠近你在找什么对于。 –

回答

6

检出ri工具。例如。

ri Array#sort 

随着输出:

------------------------------------------------------------- Array#sort 
array.sort     -> an_array 
array.sort {| a,b | block } -> an_array 
------------------------------------------------------------------------ 
Returns a new array created by sorting _self_. ... 
+0

我喜欢'ri -f ansi -T'!是否有可能通过'ri'或其他工具来查看Array#排序的实现? – user1015384

+1

好棒,pry可以使用相同的语法显示源代码,当pry-doc gem存在时加上C实现的方法的源代码https://github.com/pry/pry/wiki/Source-browsing – user1015384