Was ist der Unterschied zwischen ri und rdoc

Question

Immer wenn ich Edelsteine ​​installiere, sehe ich, dass ri und rdoc folgen. Ich weiß, das ist Dokumentation, aber was ist der Unterschied zwischen den beiden und wie man sie benutzt?

Answer 1

RDoc [..] ist der eingebettete Dokumentationsgenerator für die Ruby-Programmiersprache. [..] RDoc ist als Teil der Ruby-Core-Distribution enthalten.

RDoc bietet auch die Engine zum Erstellen von Ruby-RI-Dateien. ri ist (mehr oder weniger) Rubys Version von man-Seiten, die API-Informationen von der Kommandozeile aus bedienen.

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

Answer 2

• RDoc generiert automatisch Dokumentation aus den Kommentaren und Struktur des Codes. https://github.com/rdoc/rdoc Also denke Doxygen. Verwenden Sie es, um eine automatische Dokumentation für den von Ihnen geschriebenen Code zu generieren.
• ri ist Offline-Hilfe-Dateien zum Beispiel, wenn Sie kein Internet haben. http://www.caliban.org/ruby/rubyguide.shtml#ri Denken Sie perldoc. Verwenden Sie es, wenn Sie eine Frage zu einer Klasse haben, sollten wie ri Enumerator bringen

Enumerator < Objekt

---

= Eingeschlossen sind: Enumerable (von Ruby Kern)

(von Ruby Kern) ----------------------------------------------- ------------------------------- Eine Klasse, die sowohl interne als auch externe Iterationen erlaubt.

Ein Enumerator kann mit den folgenden Methoden erstellt werden. * Kernel # to_enum * Kernel # enum_for * Enumerator.new

Die meisten Methoden haben zwei Formen: eine Blockform, wo der Inhalt für jedes Element in der Aufzählung ausgewertet ist, und ein nicht-Block bilden, der zurückkehren ein neuer Enumerator, der die Iteration umschließt.

Enumerator =% w (eins zwei drei) .each puts enumerator.class # => Enumerator enumerator.each_with_object ("foo") do | item, obj | puts "# {obj}: # {item}" end # foo: eins # foo: zwei # foo: drei enum_with_obj = enumerator.each_with_object ("foo") puts enum_with_obj.class # => Enumerator enum_with_obj.each do | Gegenstand, obj | puts "# {obj: # {item}" end # foo: ein # foo: zwei # foo: drei

So können Sie Kette Enumeratoren zusammen ........

Answer 3

Um auf den lokalen RDoc für Ihre Edelsteine ​​zuzugreifen, geben Sie gem server ein und zeigen Sie Ihren Browser auf http://localhost:8808. Wenn die RDocs für Ihre Edelsteine ​​nicht installiert sind, installiert gem rdoc --all die Dokumentation für alle Ihre Edelsteine.

Es mag scheinen, als ob lokale Dokumentation nicht notwendig ist. Viele Entwickler verzichten bewusst auf die Installation zugunsten der Online-Dokumentation.Aber für diejenigen von uns, die Legacy-Tools wie Rails 2 verwenden, kann es die Suche nach der richtigen Dokumentation schnell und einfach machen.