Gibt es eine gute, solide Referenz für die richtige RDoc-Syntax?

Ich suche eine gute, solide Referenz für die richtige RDoc-Syntax. Empfehlungen? Ich kann anscheinend nichts finden, was deutlich zeigt:

1. Dokumentieren von Klassenmethoden und ihren Parametern
2. So dokumentieren Sie, was eine Klasse oder Klassenmethode tut.

Ein offizielles Rdoc-Beispiel mit seiner GitHub-Quelle finden Sie hier .

Die Dokumentation unter rdoc.rubyforge.org scheint vollständiger zu sein als die Version unter rdoc.sourceforge.net (die übrigens ein Änderungsdatum von 2003 hat).

Es gibt auch eine gute Quelle für Beispiele: den Ruby-Core und die stdlib-Dokumentation. Schauen Sie sich beispielsweise eine der Klassenmethoden aus der FileKlasse an :

File.atime (Dateiname) => Zeit

Gibt die letzte Zugriffszeit für die benannte Datei als Zeitobjekt zurück.

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

Sie können den ursprünglichen Quellcode einschließlich des RDoc-Markups anzeigen, indem Sie auf die erste Zeile klicken (auf der eigentlichen RDoc-Seite, nicht in dem Zitat, das ich in dieser Antwort angegeben habe). In diesem Fall wurde die Methode in C implementiert, die RDoc-Formatierung ist jedoch dieselbe wie 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
 *     
 */

Daraus können Sie ersehen, dass call-seq:Sie den Methodennamen und die Parameter durch Text Ihrer Wahl ersetzen können, was für Klassenmethoden sehr nützlich ist. Es wird auch gezeigt, wie Sie Beispielcode in einer monospaced Schriftart anzeigen können, indem Sie ihn einrücken, ähnlich wie bei Markdown.

Da RubyForge im Ruhestand ist , gibt es hier einen neuen Link:

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