rdoc, Seitenzahl 1

RDoc ist der standardmäßige eingebettete Dokumentationsgenerator für Ruby. Rdoc generiert strukturierte Dokumentation, auf die über einen Webbrowser oder die Befehlszeile zugegriffen werden kann, indem der Code und speziell formatierte Kommentare analysiert werden. Auch ohne Kommentare wird rdoc Dokumentation mit einer Programmstruktur generieren.

Antworten

Wie kann ich RDOC von bereits installierten Edelsteinen installieren?

Ich habe einige Edelsteine, die keine ri / rdoc-Dateien haben, und ich würde gerne wissen, ob es eine Möglichkeit gibt, diese rdoc-Dateien zu installieren.

21.06.2011, 03:02

Antworten

Was ist der Grund / die Geschichte für die # Konvention, Methoden in Ruby zu identifizieren?

Zum Beispiel habe ich immer Methoden gesehen, die als String#split , aber niemals String.split bezeichnet werden, was etwas logischer erscheint. Oder vielleicht sogar String::split , weil Sie #split im Namensraum von String betracht...

26.06.2010, 09:57

Antwort

Wie füge ich eine RDoc-Dokumentation für eine Methode hinzu, die mit class_eval definiert wurde?

Ich verwende class_eval , um eine Reihe repetitiver Methoden genauer zu definieren, etwa so: %Vor% Ich möchte, dass alle resultierenden Methoden in die RDoc-Dokumentation aufgenommen werden. Gibt es eine RDoc-Direktive, die "manuell" eine...

13.08.2012, 02:27

Antworten

Dokumentation für Modellbereiche in Schienen hinzufügen

Ich bin nicht sicher, ob dies tatsächlich möglich ist oder nicht, aber ich versuche, die Dokumentation unserer Rails-App vollständiger zu machen, indem wir Dokumentation für die Bereiche in unseren app/models -Dateien hinzufügen. Was ich vers...

01.09.2011, 17:11