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 , generando una colección estructurada de páginas para objetos y métodos de Ruby . Los comentarios de código se pueden agregar 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 RD asociado).
RDoc puede producir documentación utilizable incluso si el código fuente de destino no contiene comentarios explícitos, ya que aún analizará las clases , módulos y métodos, y los enumerará en los archivos API generados . RDoc también proporciona el motor para crear archivos de datos Ruby ri, proporcionando acceso a la información de la API desde la línea de comandos .
RDoc admite cuatro lenguajes de marcado, RDoc Markup, Markdown , tomdoc y rdtool. Su propio marcado RDoc se utiliza de forma predeterminada. En RDoc Markup, las directivas especiales se incluyen entre dos puntos. Por ejemplo, para indicar que un método toma argumentos llamados sitey article, se puede escribir :args: site, article. [1]