Comment puis-je documenter les méthodes implicites à l'intérieur des modèles de rails?

Question

J'utilise YARD sur mon projet Rails et je me demandais comment j'irais documentant héritée / sur les méthodes d'exécution sur un modèle Rails? Par exemple documenter l'existence d'un attribut first_name sur un modèle User.

Answer 1

Vous ne pouvez pas le faire, à mon humble avis.

Le problème est que ces méthodes ne sont pas vraiment « exister »; Ils sont « créés à la volée » par des crochets method_missing, la première fois qu'ils sont appelés, au moment de l'exécution.

D'autres systèmes de génération de documentation ont les moyens de déclarer les méthodes « implicites ». Par exemple, NaturalDocs a une fonction mot-clé qui vous permet de créer des fonctions qui existent uniquement sur les commentaires. Je ne suis pas assez familier avec YARD, mais il semble qu'il ne dispose pas d'une fonctionnalité similaire.

Bonne chance!