2009-12-11 5 views
6

Ich habe noch nie den Punkt der Installation der ri und rdoc für Edelsteine ​​gesehen und meine .gemrc Datei hat --no-ri und --no-rdoc gesetzt. Da jedes Juwel ri und rdoc Informationen enthält, habe ich mich gefragt, ob ich etwas verpasse? Gibt es einen Vorteil bei der Installation von ri und rdoc für einen Edelstein?Fehle ich etwas, indem ich nicht ri und rdoc für Edelsteine ​​installiere?

Dank

Chris

Zusammenfassung

Wenn Sie die ri und rdoc nicht installieren, müssen Sie nicht etwas von großem Wert verlieren. Ich dachte, dass es vielleicht in einigen IDEs verwendet wurde (ich bin ein Emacs-Benutzer), aber das scheint nicht der Fall zu sein.

Antwort

11

Der Punkt der Installation von RI-Dokumentation ist einfach, dass Sie den "ri" -Befehl verwenden können, um auf die Methode-für-Methode-Dokumentation zuzugreifen. Probieren Sie zum Beispiel: "ri String # reverse". Beenden Sie mit "q".

Um die RDoc-Dokumentation auszuprobieren, führen Sie "gem server" aus und stellen Sie eine Verbindung zu localhost: 8808 in Ihrem Browser her. Ich finde es nützlich - Sie können sogar auf einen Methodennamen klicken, um den Quellcode zu sehen. Natürlich können Sie einfach in den Ordner "Gems" gehen und die HTML-Dateien im Doc-Ordner öffnen.

Eine alternative Möglichkeit zum Zugriff auf RDoc ist der Befehl gemdoc. Siehe http://www.stephencelis.com/2008/06/12/bashfully-yours-gem-shortcuts.html. Das ist ziemlich praktisch, IMHO.

Wie auch immer, Sie können faul sein und warten, bis Sie die RDoc-Dokumentation benötigen, und dann mit "gem rdoc" generieren.

+0

Danke für die Erwähnung von Gem Server –

2

Installieren Sie es, wenn Sie lokal verfügbare Dokumentation für den Edelstein möchten.

+0

Also nicht wirklich etwas fehlt dann. –

3

Persönlich installiere ich meine Edelsteine ​​auch ohne rdoc und ri, denn normalerweise findet man auch im Internet alle benötigten Dokumentationen (zB www.rdoc.info), so dass man nicht hart investieren muss Speicherplatz und Zeit in Anspruch nehmen die Erzeugung

0

Dieser Artikel eines großes gibt, warum und wie die Verwendung von ri:

http://jstorimer.com/ri.html

bester Punkt auf dieser Liste ist # 1: ri versteht Rubin. Zum Beispiel:

$ ri ActiveRecord::Base#save 
(from gem activerecord-3.2.8) 
Implementation from ActiveRecord::Persistence 

[...] 

(from gem activerecord-3.2.8) 
Implementation from ActiveRecord::Validations 

[...] 

Hinweis ist das Verfahren auch wenn sie nicht direkt auf Activerecord :: Base selbst gefunden.

Verwandte Themen