Qual è la differenza tra ri e rdoc

Question

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

Answer 1

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

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

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

Answer 2

• RDoc genera automaticamente la documentazione dai commenti e struttura del codice. https://github.com/rdoc/rdoc Quindi pensa a Doxygen. Usalo per generare la documentazione automatica per il codice che hai scritto.
• ri è un file di guida offline, ad esempio se non si dispone di Internet. http://www.caliban.org/ruby/rubyguide.shtml#ri Pensa al perldoc. Usalo quando hai una domanda su una classe, come ri Enumerator dovrebbe far apparire

Enumerator < oggetto

---

= Include: Enumerable (dal nucleo rosso rubino)

(dal rubino core) ----------------------------------------------- ------------------------------- Una classe che consente l'iterazione interna ed esterna.

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

maggior parte dei metodi hanno due forme: una forma di blocco in cui i contenuti sono valutata per ogni elemento nella enumerazione, e una forma non-blocco che rendimenti un nuovo Enumeratore che avvolge l'iterazione.

enumeratore =% w (uno due tre) .each mette enumerator.class # => Enumeratore enumerator.each_with_object ("foo") do | item, obj | inserisce "# {obj}: # {item}" fine # foo: one # foo: two # foo: three enum_with_obj = enumerator.each_with_object ("foo") puts enum_with_obj.class # => Enumeratore enum_with_obj.each do | voce, obj | puts "# {obj: # {oggetto}" end # pippo: una # foo: due # pippo: tre

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

Answer 3

Per accedere all'RDoc locale per le gemme, digitare gem server e puntare il browser su http://localhost:8808.

Se gli RDoc per le gemme non sono installati, gem rdoc --all installerà la documentazione per tutte le gemme.

Potrebbe sembrare che la documentazione locale non sia necessaria. Molti sviluppatori saltano volutamente l'installazione a favore della documentazione online.Tuttavia, per quelli di noi che utilizzano strumenti legacy come Rails 2, può rendere la ricerca della documentazione giusta facile e veloce.