Was ist der Unterschied zwischen ri und rdoc

Question

Jedes Mal, wenn ich gems installieren sehe ich ri und rdoc folgen. Ich weiß, das ist die Dokumentation, aber was ist der Unterschied zwischen den beiden und wie sie verwendet werden?

Answer 1

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

RDoc bietet auch den Motor für Dateien Ruby-ri-Daten zu schaffen. Ruby-Version von Manpages ri ist (mehr oder weniger), API Informationen über die Befehlszeile serviert.

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

Answer 2

Um die lokale RDoc für Ihre Edelsteine ??zuzugreifen, geben Sie gem server und mit Ihrem Browser auf http://localhost:8808.

Wenn die RDocs für Ihre Edelsteine ??nicht installiert sind, gem rdoc --allwill die Dokumentation für alle Ihre Edelsteine ??installieren.

Es könnte scheinen, wie lokale Dokumentation ist nicht erforderlich. Viele Entwickler überspringen gezielt es für Online-Dokumentation zu installieren. Doch für diejenigen von uns, Rails mit Legacy-Tool wie 2, kann sie macht die richtige Dokumentation schnell und einfach zu finden.

Answer 3

• RDoc generiert automatisch Dokumentation aus den Kommentaren und Struktur des Codes. https://github.com/rdoc/rdoc So denken Doxygen. Verwenden Sie es generieren automatische Dokumentation für Code, den Sie geschrieben haben.
• ri ist offline Hilfedateien zum Beispiel, wenn Sie nicht Internet. http://www.caliban.org/ruby/rubyguide.shtml#ri Denken perldoc. Verwenden Sie es, wenn Sie eine Frage zu einer Klasse, wie ri Enumerator bringen sollte

  

Enumerator