Come posso documentare i metodi impliciti all'interno dei modelli di rotaie?

Question

YARD sul mio progetto Rails e chiedevo come andrei circa documentano ereditato / metodi di esecuzione su un modello di Rails? Per esempio documentare l'esistenza di un attributo first_name su un modello User.

Answer 1

Non si può fare che, secondo la mia opinione.

Il problema è che questi metodi in realtà non "esiste"; Essi sono "create al volo" tramite ganci method_missing, la prima volta che vengono invocate, in fase di esecuzione.

Altri sistemi di generazione di documentazione hanno modi per dichiarare metodi "implicito". Ad esempio NaturalDocs ha un href="http://www.naturaldocs.org/keywords.html" rel="nofollow noreferrer"> funzione che ti permette di creare funzioni che esistono solo sui commenti. Non sono abbastanza familiarità con YARD, ma sembra che non dispone di una funzionalità simile.

In bocca al lupo!