Rdoc, el generador de documentación de Ruby

Rdoc es el generador de documentación de Ruby por defecto. Es muy útil para generar la documentación de librerías que luego has de reutilizar.

Básicamente parsea recursivamente todos los archivos .rb, .rbw y .c del subdirectorio actual, en busca de comentarios encima de la definición de cada función y al inicio del fichero. Con todos estos datos crea archivos HTML en un subdirectorio llamado "doc". Un ejemplo del resultado es: api.rubyonrails.com

Para ejecutarlo hay que llamar a:
rdoc

Unos flags útiles son:

• --main [PATH a un fichero], hará que el fichero apuntado sea el que aparezca como inicio en la documentación generada.


• --all, incluye también métodos privados en la documentación (por defecto solo incluye los públicos).


• --op [PATH a un directorio], utiliza este directorio para guardar la documentación en lugar de "doc".


• --inline-source, incluye el código fuente de cada método en la documentación.

Reglas básicas de marcado:

• = cabecera de nivel 1


• == cabecera de nivel 2


• * o - crea un elemento de una lista


• # crea un elemento de una lista numerada


• Con las palabras se puede hacer: _italica_, *negrita* y +codigo+

Más información:

• rdoc.sourceforge.net

Etiquetas: rdoc ruby rubyonrails