web-dev-qa-db-fra.com

Pourquoi l'utilisation de la balise @uses dans docblocks est-elle déconseillée?

Voir normes de documentation en ligne

Remarque: cette balise a déjà été utilisée mais ne doit plus l'être.

Ce qui donne?

Je construis un plugin pour construire un codex à partir de la source d'un plugin/thème et je pense que la balise @uses serait parfaite pour relier des fonctions à des crochets et des crochets à des fonctions.

6
Stiofan O'Connor

Je ne suis pas sûr à 100% mais je suppose que c'est parce que l'utilisation de @uses peut être recouverte de @see

À partir de la documentation phpDocumentor

@us est très similaire à @see, consultez la documentation de @see pour plus de détails sur le format et la structure. La balise @uses diffère de @see de deux manières. @see est un lien à sens unique, ce qui signifie que la documentation contenant une balise @see contient un lien vers une autre documentation. La balise @uses crée automatiquement une balise virtuelle @usedby dans l'autre documentation reliée à la documentation contenant la balise @uses. En d'autres termes, c'est exactement comme @see, sauf qu'un lien de retour est ajouté automatiquement.

L’autre différence est que @user n’accepte qu’un élément avec lequel créer un lien et une description de cet élément.

Probablement, WP personnes ont décidé qu'il ne valait pas la peine d'avoir 2 balises si similaires mais de n'en conserver qu'une.

BTW, @uses est un tag fin. Si vous voulez le supporter, faites-le et documentez-le dans la documentation.

5
gmazzap