Wie kann ich implizite Methoden innerhalb von Schienen Modelle dokumentieren?

Question

Ich bin mit YARD auf meinem Rails-Projekt und habe mich gefragt, wie ich über Dokumentierende geerbt / runtime Methoden geht auf ein Rails-Modell? Zum Beispiel dokumentiert die Existenz eines first_name Attributs auf einem User Modell.

Answer 1

Sie können das nicht tun, IMHO.

Das Problem ist, dass diese Methoden nicht wirklich „existieren“; Sie werden über method_missing Haken "on the fly erstellt", das erste Mal, wenn sie aufgerufen werden, auf der Laufzeit.

Andere Dokumentation Erzeugungssysteme haben Wege „implizite“ Methoden zu erklären. Zum Beispiel NaturalDocs hat eine Funktion Stichwort , die Sie Funktionen erstellen können, die nur auf die Kommentare vorhanden. Ich bin nicht vertraut genug mit YARD, aber es scheint es nicht eine ähnliche Funktionalität hat.

Viel Glück!