Conociendo Rdoc

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/.


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.

De momento hay 4 comentarios ¿Quieres dejar el tuyo?

  1. [...] implementación es sumamente sencilla, algo muy similar a la herramienta rDoc del Lenguaje Ruby. Voy a continuar experimentando un poco más y bueno ustedes también estás [...]

  2. [...] con un formato profesional y de manera instantánea. Hay más información en Wikipedia, Spejmank, elcodigok y [...]

  3. [...] con un formato profesional y de manera instantánea. Hay más información en Wikipedia, Spejmank, elcodigok y [...]

Leave a Reply

*

web stats