Cuál es la diferencia entre ri y rdoc

Question

Cada vez que instalo gemas, veo que ri y rdoc siguen. Sé que esto es documentación, pero ¿cuál es la diferencia entre los dos y cómo usarlos?

Answer 1

RDoc [..] es el generador de documentación integrado para el lenguaje de programación Ruby. [..] RDoc se incluye como parte de la distribución central de Ruby.

RDoc también proporciona el motor para la creación de ficheros de datos ri Ruby. ri es (más o menos) la versión de las páginas man de Ruby, que sirve información de la API desde la línea de comandos.

Desde: http://en.wikipedia.org/wiki/RDoc

Answer 2

• RDoc genera automáticamente la documentación de los comentarios y estructura de su código. https://github.com/rdoc/rdoc Así que piense Doxygen. Úselo para generar documentación automática para el código que ha escrito.
• ri es archivos de ayuda sin conexión, por ejemplo, si no tiene internet. http://www.caliban.org/ruby/rubyguide.shtml#ri Piensa perldoc. Utilizarlo cuando usted tiene una pregunta acerca de una clase, como ri Enumerator debería mostrar

enumerador < objeto

---

= Incluye: Enumerable (de rubí central)

(de rubí núcleo) ----------------------------------------------- ------------------------------- Una clase que permite la iteración interna y externa.

un enumerador puede ser creado por los métodos siguientes. * Kernel # to_enum * Kernel # enum_for * Enumerator.new

mayoría de los métodos tienen dos formas: una forma de bloque, donde los contenidos son evaluado para cada elemento de la enumeración, y una forma no bloque que rendimientos un nuevo Enumerador que envuelve la iteración.

enumerador =% w (uno dos tres) .each pone enumerator.class # => Enumerador enumerator.each_with_object ("foo") do | item, obj | puts "# {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 | artículo, obj | pone "# {obj: # {item}" end # foo: uno # foo: dos # foo: tres

Esto le permite encadenar Enumeradores juntos ........

Answer 3

Para acceder al RDOC local para sus gemas, escriba gem server y dirija su navegador al http://localhost:8808.

Si no se instalan los RDocs para sus joyas, gem rdoc --all se instalará la documentación para todas sus joyas.

Podría parecer como documentación local no es necesario. Muchos desarrolladores omiten instalarlo a favor de la documentación en línea.Sin embargo, para aquellos de nosotros que usamos herramientas heredadas como Rails 2, puede hacer que encontrar la documentación correcta sea rápido y fácil.