C'è un buon, solido riferimento per una corretta sintassi RDoc?

Question

Sto cercando una buona, solido riferimento per una corretta sintassi RDoc. Raccomandazioni? Non riesco a trovare nulla che mostra chiaramente:

1. Come metodi di classe documento ei relativi parametri
2. Come documentare ciò che un metodo di classe o di classe fa.

Answer 1

Un esempio ufficiale rdoc può essere trovato qui , con la sua GitHub fonte .

La documentazione a rdoc.rubyforge.org sembra essere più completo rispetto alla versione a rdoc.sourceforge.net (che ha inciso una data di modifica 2003).

Inoltre, v'è una grande fonte di esempi: il nucleo di Ruby e la documentazione stdlib. Ad esempio, dare un'occhiata a uno dei metodi della classe dal href="http://ruby-doc.org/core-1.8.7/classes/File.html" rel="nofollow noreferrer"> File classe :

  

File.atime (file_name) => tempo

     

Restituisce il tempo di accesso per l'ultima   nome file come un oggetto Tempo).

     

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

È possibile visualizzare il codice sorgente originale, compreso il markup RDoc, facendo clic sulla prima riga (nella pagina effettiva RDoc, non nella citazione ho incluso in questa risposta). In questo caso, il metodo è stato implementato in C, ma la formattazione RDoc è come se fosse implementata in rubino:

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

Da questo si può vedere che call-seq: consente di sostituire il nome del metodo e parametri con il testo di vostra scelta, che è molto utile per i metodi di classe. Essa mostra anche come è possibile visualizzare codice di esempio in un font a spaziatura fissa da rientro che, simile a Markdown.

Answer 2

RubyForge è stato ritirato , ecco un nuovo link:

http: // ruby-doc. org / stdlib-2.5.1 / libdoc / rdoc / rdoc / rDoc / Markup.html