RDoc

RDoc , diseñado por Dave Thomas , es un generador de documentación integrado para el lenguaje de programación Ruby . Analiza el código fuente de Ruby y genera una colección estructurada de páginas para objetos y métodos de Ruby . Se pueden agregar comentarios de código en un estilo natural. RDoc se incluye como parte de la distribución principal de Ruby. El software y el formato RDoc son sucesores del formato de documento Ruby (con el software asociado RD).

RDoc puede generar documentación utilizable incluso si el código fuente de destino no contiene comentarios explícitos, ya que analizará las clases , los módulos y los métodos y los incluirá en los archivos API generados . RDoc también proporciona el motor para crear archivos de datos ri de Ruby, lo que brinda acceso a la información API desde la línea de comandos .

Actualmente, Eric Hodel y Ryan Davis mantienen RDoc y ri.

Sintaxis

RDoc admite cuatro lenguajes de marcado: RDoc Markup, Markdown , tomdoc y rdtool. De forma predeterminada, se utiliza su propio lenguaje de marcado RDoc. En RDoc Markup, las directivas especiales se encierran entre dos puntos. Por ejemplo, para indicar que un método acepta argumentos llamados sitey article, se puede escribir :args: site, article. ^[1]