Was ist der schnellste Weg, um Dokumentation für Ruby zu bekommen? [geschlossen]

Question

sagen, ich bin etwas Ruby-Code zu schreiben, und ich mag den Standard-Datumstyp verwenden, um das aktuelle Datum zu erhalten. Statt eine Suchmaschine gibt es einen schnellen Weg, um die Dokumentation für diese Klasse zu finden? Ich weiß, ich kann die Methoden für Datum erhalten, indem Date.methods eingeben, aber soweit ich weiß, dass dies bietet keine Details über Argumenttypen oder Rückgabewert.

Editor-spezifische Antworten sind willkommen. Mein Redakteur der Wahl ist Emacs.

Answer 1

ein Lesezeichen auf den Rubin Kern docs

Verwenden der find-Textbefehl Webbrowser.

Unexpected wie es scheinen mag, ich finde das ist eigentlich schneller als ri verwenden, die aus irgendeinem Grund Ewigkeiten zu dauern scheint bis zu starten.

Es ist auch viel besser als ri weil die HTML-Seite für alle Methoden, die auf einer einzigen Seite alle Unterlagen aufgeführt sind. Oft sind Methoden auf andere bezogen, und das Umschalten zwischen 2 ri des schmerzt

Answer 2

Auf der Konsole verwenden "ri"

ri Date

Das funktioniert mit allen Klassen. (Z ri String) Um zu sehen Dokumentation für eine bestimmte Methode, die Sie verwenden:

ri Date#yourMethod

Answer 3

Die kanonische Quelle für Ruby Dokumentation ist Rubin-doc - die beiden dort Links, die von den meisten Interesse sind Kern und Standardbibliothek . Sie erhalten eine Darstellung javadoc-Stil, die in der Regel Argumenttypen und Rückgabewerte abdeckt. Sie können sogar Ihre eigenen machen mit RDoc .

Answer 4

Für diejenigen von Ihnen, die Dokumente aus Vanille-IRB

wollen

1. diese Anweisungen für den Kern RI Einrichtung Dokumentation. Wie des Schreibens sind die Schritte

   $ cd ~/.rvm/src
   $ rvm docs generate-ri
   

2. Jetzt können Sie Dokumente für eine bestimmte Methode auf der Kommandozeile mit dem Befehl ri anzuzeigen. So ruft es aus IRB, verwenden Sie den Befehl help:

   $ irb
   irb(main):001:0> help 'String#chomp'