ri和rdoc有什么区别

Question

每当我安装宝石时,我都会看到ri和rdoc.我知道这是文档,但两者之间有什么区别以及如何使用它们？

Answer 1

RDoc [..]是Ruby编程语言的嵌入式文档生成器.[..] RDoc是Ruby核心发行版的一部分.

RDoc还提供了用于创建Ruby ri数据文件的引擎.ri是(或多或少)Ruby的手册页版本,从命令行提供API信息.

来自:http: //en.wikipedia.org/wiki/RDoc

Answer 2

要访问宝石的本地RDoc,请键入gem server并指向您的浏览器http://localhost:8808.

如果未安装宝石的RDoc,gem rdoc --all将安装所有宝石的文档.

看起来似乎没有必要使用本地文档.许多开发人员故意跳过安装它以支持在线文档.但是,对于我们这些使用Rails 2等传统工具的人来说,它可以快速,轻松地找到合适的文档.

Answer 3

• RDoc从代码的注释和结构中自动生成文档.https://github.com/rdoc/rdoc所以想想Doxygen.使用它为您编写的代码生成自动文档.
• ri是离线帮助文件,例如,如果您没有互联网.http://www.caliban.org/ruby/rubyguide.shtml#ri想想perldoc.当你对课程有疑问时使用它,就像ri Enumerator应该提出来一样

枚举器<对象

=包括:可枚举(来自红宝石核心)

(来自ruby core)--------------------------------------------- ---------------------------------允许内部和外部迭代的类.

可以通过以下方法创建枚举器.*内核#to_enum*内核#enum_for*Enumerator.new

大多数方法都有两种形式:一种是块形式,其中内容是为枚举中的每个项目计算的,另一种是非块形式,它返回一个包含迭代的新枚举器.

enumerator =%w(一二三).each puts enumerator.class#=> Enumerator enumerator.each_with_object("foo")do | item,obj | put"#{obj}:#{item}"end#foo:one#foo:two#foo:three enum_with_obj = enumerator.each_with_object("foo")puts enum_with_obj.class#=> Enumerator enum_with_obj.each do | item, OBJ | put"#{obj:#{item}"end#foo:one#foo:two#foo:three

这允许你将枚举器链接在一起........