¿Cuál es la diferencia entre ri y rdoc

Question

Cada vez que instalo gemas veo seguimiento ri y rdoc. 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 núcleo Ruby.

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

A partir de: http://en.wikipedia.org/wiki/RDoc

Answer 2

Para acceder a la RDoc local para sus gemas, tipo gem server y escribir en el navegador http://localhost:8808.

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

Puede parecer documentación local no es necesario. Muchos desarrolladores se saltan a propósito de instalarlo en favor de la documentación en línea. Sin embargo, para aquellos de nosotros usando herramientas tradicionales como los carriles 2, se puede hacer la búsqueda de la documentación de la derecha rápida y fácil.

Answer 3

• RDoc genera automáticamente la documentación de los comentarios y estructura de su código. https://github.com/rdoc/rdoc por lo que pensar Doxygen. Utilizarlo para generar la documentación automática de código que ha escrito.
• ri es archivos de ayuda fuera de línea, por ejemplo, si usted no tiene Internet. http://www.caliban.org/ruby/rubyguide.shtml#ri Piense perldoc. Utilizarlo cuando usted tiene una pregunta acerca de una clase, como ri Enumerator debe abrir

  

enumerador