Esiste un riferimento valido e valido per la corretta sintassi RDoc?

Question

Sto cercando un riferimento valido e solido per la corretta sintassi RDoc. Raccomandazioni? Non riesco a trovare nulla che mostra chiaramente:

1. Come documentare i metodi della classe e dei relativi parametri
2. Come documentare ciò che un metodo di classe o di classe fa.

Answer 1

Aggiornamento link morto documentazione più recente rdoc può essere trovato qui https://ruby.github.io/rdoc/ExampleRDoc_rdoc.html

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, c'è una grande fonte di esempi: la documentazione di nucleo e stdlib di Ruby. Ad esempio, dare un'occhiata a uno dei metodi di classe dalla File class:

File.atime (file_name) => tempo

Restituisce l'ora dell'ultimo accesso per il file denominato come un tempo oggetto).

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

È possibile visualizzare il codice sorgente originale, compreso il markup RDoc, cliccando 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 è la stessa come se fosse stata attuata in 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 
*  
*/ 

Da questo si può vedere che call-seq: consente di sostituire il nome del metodo e dei parametri con testo di tua scelta, che è molto utile per i metodi di classe. Mostra anche come è possibile visualizzare il codice di esempio in un font monospazio facendolo rientrare, simile a Markdown.

Answer 2

Dal RubyForge has been retired, ecco un nuovo link:

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