2011-11-10 32 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