J'ai ce que j'ai supposé avoir été une utilisation de macro macro de la cour assez basique où j'ai une structure de hasch avec un certain nombre d'options partagées entre plusieurs fonctions. J'espérais utiliser une macro simplement pour m'empêcher de devoir reproduire cette structure partout, mais cela ne semble pas fonctionner comme ça.
Ce que je m'attendais à travailler était: et avoir H1 et H2 documenté correctement. Je pense que j'ai compris que au moins le 1 $ ne fonctionne pas comme ça prend plutôt de la fonction elle-même mais je peux appeler les deux paramètres H1 et remplacer 1 $ avec H1 dans la macro et je ne comprends toujours pas ce que je veux . L'exemple "Définition de macros simples" à http: //RubyDoc.info/docs/yard/file/docs/tags.md#macro indiquerait que je peux le faire (notez que je trouve des exemples avec @! macro et certains sans que cela ne semble ni ne semble pas fonctionner). Je ne sais pas beaucoup de cour, mais cela ne fonctionne tout simplement pas? Y a-t-il quelque chose de similaire que je peux faire pour atteindre mon résultat? Existe-t-il une fonction de débogage qui expliquerait ceci car aucune erreur ne vient dans la console de serveur de yard? merci
3 Réponses :
Comme vous spécifiez déjà dans la macro, il doit être étendu au premier paramètre de la méthode, que vous n'avez pas besoin de le spécifier lors de l'expansion de la macro. Il semble également qu'il semble impossible de dire pour quel paramètre expandir macro. Une autre chose est que vous pouvez sauter [nouveau] dans ce cas et semble qu'il est préférable d'utiliser @! Macro au lieu de @macro .
Quelle est la différence entre @! macro et @macro , je n'ai pas pu le trouver. Si vous voulez, veuillez répondre Ma question .
Je crois que vous pouvez accomplir ce que vous recherchez avec des chantiers Tags de référence .
de la DOCS: P>
Si les données d'une balise commencent par
(voir objet) code> il est considéré comme une "référence tag ". Une balise de référence copie littéralement les données de balise par la balise donnée Nom de l'objet spécifié. Par exemple, une méthode peut copier tout @param tags à partir d'un objet donné à l'aide de la syntaxe de la balise de référence: p># @param [String] user the username for the operation # @param [String] host the host that this user is associated with # @param [Time] time the time that this operation took place def clean(user, host, time = Time.now) end # @param (see #clean) def activate(user, host, time = Time.now) end
Ceci fonctionne avec YARDOC 0.9.8 (probablement une version): Notez la marque d'exclamation manquante! Lorsque vous appelez la macro avec @macro . Ceci est le bon Syntaxe YARDOC .
Je ne comprends pas la documentation non plus, mais la question de la question itérant sur le Les registres d'un yardoc
@macrosont pertinents.