Estaba desarrollando un mini proyectito en Ruby, y me encontré ante la necesidad de generar documentación automática sobre dicho proyecto.
“RDoc”:http://rdoc.sourceforge.net/ es el programa mas usado dentro de Ruby para lo que plantee en el párrafo anterior.
En Ubuntu Karmic disponemos de los siguientes paquetes
bc. $ sudo aptitude search rdoc
i A rdoc – Generate documentation from ruby source files
i A rdoc1.8 – Generate documentation from Ruby source files (for Ruby 1.8)
p rdoc1.9 – Generate documentation from Ruby source files (for Ruby 1.9)
p rdoc1.9.1 – Generate documentation from Ruby source files (for Ruby 1.9.1)
Les dejo cortito la forma de uso del programa y una salida. Para que se den una idea del resultado, “fijense por aquí”:http://www.ruby-doc.org/core/.
bc. rdoc [opciones]
bc. $ rdoc –op doc/ –all
bc. fileHandled.rb: ……
varios.rb: …..
abmc.rb: …….
app.rb: .
main.rb: ..
altas_testing.rb:
files_testing.rb:
abmc.rb: …….
meta.rb: …….
fileHandled.rb: …….
varios.rb: …..
hashing.rb: …….
main.rb: .
abmc.rb: …….
fileHandled.rb: …….
varios.rb: …..
hashing.rb: …..
Generating HTML…
bc. Files: 17
Classes: 0
Modules: 0
Methods: 79
Elapsed: 21.324s
La verdad que funciono de maravilla, aunque recomiendo leer bien la documentación, porque se puede hacer que cada método tenga una descripción apropiada poniendo los comentarios en el lugar correcto, entre las pocas cosas que pude aprender. Les dejo la intriga 😉
Fuente:
“El generador de documentos de Ruby”:http://spejman.blogspot.com/2008/02/rdoc-el-generador-de-documentacin-de.html
