¿Existen ciertas convenciones de código al documentar el código ruby? Por ejemplo, tengo el siguiente fragmento de código:
require 'open3'
module ProcessUtils
# Runs a subprocess and applies handlers for stdout and stderr
# Params:
# - command: command line string to be executed by the system
# - outhandler: proc object that takes a pipe object as first and only param (may be nil)
# - errhandler: proc object that takes a pipe object as first and only param (may be nil)
def execute_and_handle(command, outhandler, errhandler)
Open3.popen3(command) do |_, stdout, stderr|
if (outhandler)
outhandler.call(stdout)
end
if (errhandler)
errhandler.call(stderr)
end
end
end
end
¿Supongo que está bien, pero tal vez hay mejores prácticas de documentación superior?
shop.oreilly.com/product/9780596516178.do tiene un pequeño ejemplo en el código fuente. Mire en el listado del capítulo 2. Es como la respuesta aquí. He jugado con rdoc solo para mostrar el código fuente. Puede hacer que su extensión de archivo sea algo como my_code.rb a my_code.rb.txt y luego ejecutar rdoc en ella. > rdoc my_code.rb.txt, entonces no importará sobre las clases y los módulos porque rdoc representará html de todos modos. Diviértete con eso.
—
Douglas G. Allen