Conociendo Rdoc

Por Daniel M. Maldonado el 25 de junio 2008. Leído 271 veces.

RDoc es un generador de documentación para el lenguaje de programación Ruby, diseñado por Davis Thomas.

Básicamente lo que realiza esta aplicación es analizar el código fuente de alguna aplicación realizada con Ruby y genera una colección de estructuras de páginas con todos los métodos y objetos utilizados en dicha aplicación.

Rdoc se encuentra y se incluye como parte del núcleo de distribución Ruby.

Para poder realizar un pequeño ejemplo con rdoc, te propongo que primeros lo instales, de hecho es más que seguro que ya lo tiene, pero por las dudas

% sudo apt-get install rdoc

ahora bien, dirígete al directorio en donde tengas códigos fuentes realizados con el lenguaje Ruby, para el ejemplo se va a llamar “ejemplo.rb”

Entonces para generar la documentación lo único que deber realizar es:

% rdoc –main ejemplo.rb

y verás como genera la documentación que se encuentra dentro del directorio doc/.

Quizás también le interese:


Artículo escrito por Daniel M. Maldonado
Tec. Informático, Analista en Sistema y Estudiante de Ing. en computación, Emprendedor, Creador y Webmaster de LaREPAWEB, El CoDiGo K, TeknoFlash, SQLite Latino.
Email del Autor | Todas las publicaciones de Daniel M. Maldonado


Agrega tu Comentario

No hay comentarios, 3 Referencias