Qual è la differenza tra il RI e rdoc

Question

Ogni volta che installo gemme vedo follow ri e rdoc. So che questo è documentazione, ma qual è la differenza tra i due e come usarli?

Answer 1

RDoc [..] è il generatore di documentazione embedded per il linguaggio di programmazione Ruby. [..] RDoc è incluso come parte della distribuzione nucleo Ruby.

RDoc fornisce anche il motore per la creazione di file di dati di Ruby ri. ri è (più o meno) la versione di Ruby di pagine man, che serve le informazioni API dalla riga di comando.

Da: http://en.wikipedia.org/wiki/RDoc

Answer 2

Per accedere al RDoc locale per i vostri gioielli, tipo gem server e puntare il browser su http://localhost:8808.

Se i rdocs per i vostri gioielli non sono installati, gem rdoc --allwill installare la documentazione per tutte le gemme.

Potrebbe sembrare documentazione locale non è necessario. Molti sviluppatori volutamente evitare di installare in favore di documentazione in linea. Tuttavia, per quelli di noi con gli strumenti legacy come Rails 2, può rendere trovare la giusta documentazione facile e veloce.

Answer 3

• RDoc genera automaticamente la documentazione dai commenti e struttura del codice. https://github.com/rdoc/rdoc in modo da pensare Doxygen. Usalo per generare la documentazione automatica per il codice che hai scritto.
• ri è file di aiuto in linea, ad esempio, se non si dispone di internet. http://www.caliban.org/ruby/rubyguide.shtml#ri Pensate perldoc. Usalo quando hai una domanda su una classe, come ri Enumerator dovrebbe portare fino

  

Enumerator      

---

     

= Include: Enumerable (dal nucleo ruby)

     

(dal nucleo rubino)   -------------------------------------------------- ---------------------------- classe A che permette sia iterazione interna ed esterna.

     

un enumeratore può essere creato con i seguenti metodi.   * Kernel # to_enum   * Kernel # enum_for   * Enumerator.new

     

La maggior parte dei metodi hanno due forme: una forma di blocco in cui i contenuti sono   valutata per ogni elemento nell'enumerazione, e una forma non blocchetto   restituisce un nuovo enumeratore avvolgendo l'iterazione.

     

enumerator =% w (uno due tre) mette .each enumerator.class # =>   Enumerator enumerator.each_with_object ( "foo") fare | voce, obj |       puts "# {obj}: # {oggetto}" end # pippo: One # foo: due # foo: tre enum_with_obj = enumerator.each_with_object ( "foo") mette   enum_with_obj.class # => Enumerator enum_with_obj.each do | voce, obj |       puts "# {obj: # {oggetto}" end # pippo: una # foo: due # foo: tre

     

Questo permette di Enumerators catena insieme ........