¿Existe una buena referencia sólida para la sintaxis correcta de RDoc?

Question

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

1. cómo documentar los métodos de clase y sus parámetros
2. cómo documentar lo que hace un método de clase o clase.

Answer 1

enlace Actualización muertos documentación más reciente del rdoc se puede encontrar aquí https://ruby.github.io/rdoc/ExampleRDoc_rdoc.html

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: la documentación de Ruby core y stdlib. Por ejemplo, echar un vistazo a uno de los métodos de la clase de la File class:

File.atime (nombre_archivo) => tiempo

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

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 implementa en Rubí:

/* 
* 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 
*  
*/ 

De esto se puede ver que call-seq: le permite reemplazar el nombre del método y los parámetros con texto de su elección, que es muy útil para los métodos de clase. También muestra cómo puede mostrar el código de ejemplo en una fuente monoespaciada al sangrarlo, de manera similar a Markdown.

Answer 2

Desde RubyForge has been retired, aquí hay un enlace nuevo:

http://ruby-doc.org/gems/docs/r/rdoc-4.1.1/RDoc/Markup.html