2009-12-11 13 views
6

Nunca he visto el punto de instalar el ri y rdoc para las gemas y mi archivo .gemrc tiene --no-ri y --no-rdoc establecido. Dado que cada gema incluye información de ri y rdoc, ¿me preguntaba si me falta algo? ¿Hay alguna ventaja en instalar el ri y el rdoc para una gema?¿Me falta algo al no instalar ri y rdoc para gemas?

Gracias

Chris

Resumen

Si no instala el RI y rdoc, no se pierde nada de gran valor. Pensé que tal vez se usó en algunos de los IDEs (soy un usuario de Emacs) pero ese no parece ser el caso.

Respuesta

11

El punto de instalación de la documentación ri es simplemente que puede usar el comando "ri" para acceder a la documentación método por método. Para un ejemplo, intente: "ri String # reverse". Salir presionando "q".

Para probar la documentación de RDoc, ejecute "gem server" y luego conéctese a localhost: 8808 en su navegador. Lo encuentro útil; incluso puede hacer clic en el nombre de un método para ver el código fuente. Por supuesto, puede ir a la carpeta gems y abrir los archivos HTML en la carpeta doc.

Una forma alternativa de acceder a RDoc es el comando gemdoc. Ver http://www.stephencelis.com/2008/06/12/bashfully-yours-gem-shortcuts.html. Eso es bastante útil, en mi humilde opinión.

De todos modos, puede ser flojo y esperar hasta que necesite la documentación de RDoc, y luego generarla con "gem rdoc".

+0

Gracias por mencionar el servidor de gemas –

2

Instálelo si desea documentación localmente disponible para la gema.

+0

Entonces realmente no falta nada. –

3

Personalmente, estoy instalando mis gemas sin rdoc y ri, también, porque normalmente también puedes encontrar toda la documentación que necesitas en internet (es decir, www.rdoc.info), así que no hay necesidad de invertir mucho espacio en disco y tiempo de la generación lleva

0

en este artículo se da un gran por qué y cómo el uso de ri:

http://jstorimer.com/ri.html

mejor punto de esa lista es # 1: ri entiende Ruby. Por ejemplo:

$ ri ActiveRecord::Base#save 
(from gem activerecord-3.2.8) 
Implementation from ActiveRecord::Persistence 

[...] 

(from gem activerecord-3.2.8) 
Implementation from ActiveRecord::Validations 

[...] 

Aviso el método se encuentra incluso si no directamente en ActiveRecord :: Base sí.

Cuestiones relacionadas