生成本地Ruby文档的方法

这个在镐头书《Programming php?name=Ruby" onclick="tagshow(event)" class="t_tag">Ruby》中有介绍。

去下载一份ruby的源码，然后在源码目录下，运行rdoc文档生成程序就OK拉。如果想把源码安装到系统中，也就是可以用ri来阅读，就在rdoc后加上选项--ri-system。

这个技巧在任何以ruby或者ruby的C扩展编写的含有ruby格式的文档注释形式的代码中都可以使用，比如rails（在《Agile web》一书中有介绍用内置的rake调用rdoc来生成文档）。

一般以gem包安装的代码都带有编译好的ri文档和rdoc文档，可以启动gem_server来查看文档。