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

Question

Ich bin auf der Suche nach einer guten, solide Referenz für die richtige RDoc Syntax. Empfehlungen? Ich kann nichts scheinen zu finden, dass deutlich zeigt:

1. Wie Dokumentenklasse Methoden und deren Parameter
2. Wie zu dokumentieren, was eine Klasse oder Klassenmethode der Fall ist.

Answer 1

Ein offizielles rdoc Beispiel kann hier wird, mit GitHub Quelle .

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

Außerdem gibt es eine große Quelle der Beispiele: der Ruby-Kern und stdlib Dokumentation. Nehmen wir zum Beispiel einen Blick auf eine der Klassenmethoden aus dem File Klasse :

  

File.atime (file_name) => Zeit

     

Gibt die letzte Zugriffszeit für die   benannte Datei als Objekt Time).

     

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

Sie können den ursprünglichen Quellcode anzeigen, einschließlich der RDoc Markup, indem Sie auf der ersten Zeile (in der eigentlichen RDoc Seite, nicht in dem Zitat, das ich in dieser Antwort enthalten). In diesem Fall wurde das Verfahren in C implementiert, aber die RDoc Formatierung ist das gleiche, als ob es in Ruby implementiert:

/*
 *  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 Du, dass call-seq: sehen können Sie die Methodennamen und Parameter mit Text Ihrer Wahl ersetzen, die für Klassenmethoden sehr nützlich ist. Es zeigt auch, wie Sie Beispiel-Code in einer nichtproportionalen Schrift durch Einrücken es, ähnlich wie Markdown anzeigen können.

Answer 2

Da RubyForge hat zurückgezogen worden ist, hier ist ein neuer Link:

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