¿Hay una buena y sólida referencia para la sintaxis correcta RDoc?

Question

Estoy buscando una buena, sólida referencia para la sintaxis correcta RDoc. Recomendaciones? Parece que no puedo encontrar nada de lo que claramente muestra:

1. Como métodos de la clase de documento y sus parámetros
2. ¿Cómo documentar lo que hace un método de clase o clase.

Answer 1

Un ejemplo rdoc oficial se puede encontrar aquí , con su GitHub fuente .

La documentación en rdoc.rubyforge.org parece ser más completa que la versión en rdoc.sourceforge.net (que por cierto tiene una fecha de modificación de 2003).

Además, hay una gran fuente de ejemplos: el núcleo Ruby y documentación stdlib. Por ejemplo, echar un vistazo a uno de los métodos de la clase de la href="http://ruby-doc.org/core-1.8.7/classes/File.html" rel="nofollow noreferrer"> File clase :

  

File.atime (file_name) => tiempo

     

Devuelve el último tiempo de acceso para el   nombre de archivo como un objeto Time).

     

File.atime("testfile") #=> Wed Apr 09 08:51:48 CDT 2003

Puede ver el código fuente original, incluyendo el marcado RDoc, haciendo clic en la primera línea (en la página real RDoc, no en la cita que incluye en esta respuesta). En este caso, el método fue implementado en C, pero el formato RDoc es el mismo que si se implementó en Ruby:

/*
 *  call-seq:
 *     File.atime(file_name)  =>  time
 *  
 *  Returns the last access time for the named file as a Time object).
 *     
 *     File.atime("testfile")   #=> Wed Apr 09 08:51:48 CDT 2003
 *     
 */

A partir de esto se puede ver que call-seq: le permite reemplazar el nombre del método y los parámetros con el texto de su elección, lo cual es muy útil para los métodos de la clase. También muestra cómo puede mostrar código de ejemplo en una fuente de espacio fijo por corrugado que, al igual que de rebajas.

Answer 2

RubyForge ha sido retirado , aquí es un nuevo enlace:

http: // rubí-doc. org / stdlib-2.5.1 / libdoc / rdoc / rdoc / RDoc / Markup.html