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 versuchen möchte, ist:
Und wenn ich dann rdoc über die App l \ u00e4uft, will ich newest_records als eine öffentliche Klassenmethode zusammen mit den eher traditionellen Methoden auflisten lassen, die wie folgt dokumentiert werden:
BEARBEITEN
Ich verstehe, dass diese Frage ein wenig mehrdeutig sein kann. Also hier ist ein Versuch zu klären: Derzeit, wenn ich versuche, eine Kommentarzeile über eine scope -Deklaration hinzuzufügen, bekomme ich keine Dokumentation von RDoc für den Bereich generiert. Ich weiß, dass RDoc Metamethoden / Attribute aufnehmen kann, sonst würde es keine Attribute in den Dokumenten anzeigen, die mit attr_accessor deklariert sind. Also meine Frage ist, wie füge ich Kommentare zu meiner Datei hinzu, so dass:
Nachdem ich in den RDoc Docs herumgegrubbelt habe, glaube ich, dass ich es geschafft habe, meine eigene Frage zu beantworten.
Sie können einen Bereich wie folgt dokumentieren:
%Vor%Der Doppel-Hash wird verwendet, um meta-programmierte Methoden aufzunehmen, und wenn Sie eine Instanz-Methode erstellen, ist das alles, was Sie brauchen. Da der Bereich jedoch eine Klassenmethode erstellt, müssen Sie auch die Zeile: singleton-method: verwenden, um dies anzugeben. Die Dokumentation wird in den folgenden Zeilen wie gewohnt fortgesetzt.
Sie können die vollständige Syntax zum Dokumentieren von Meta-Methoden usw. in der RDoc-Dokumentation
Scopes sind Klassenmethoden, also macht Rdoc es richtig. Ich würde sagen, das funktioniert so weit wie Rdoc weiß.
Vielleicht haben Sie eine bessere Kontrolle, wenn Sie etwas Erweiterbares wie YARD verwenden.
Tags und Links ruby-on-rails-3 ruby-on-rails rdoc scopes