Je me demande comment je devrais utiliser @package & @subpackage pour la classe doc.
Disons que j'ai la classe suivante Si ce sera: ou ou ou Et si vous utilisez l'espace de noms au lieu de '_'?
3 Réponses :
Premier: si vous utilisez "_" ou "\" (le séparateur d'espace de noms) ne doit pas influencer votre décision, comment vous annotez vos classes. Le soulignement "_" provient d'un âge de pré-noms et "agit comme" le séparateur d'espace de noms, sauf que cela ne crée pas d'espaces de noms. Donc "my_controller_action" doit être traité comme "action" dans "my_controller".
Cependant, comment vous utilisez Conclusion: c'est à vous de choisir :) Un documentaire peut gérenater différentes structures de votre code, en fonction des balises que vous utilisez et de la manière dont vous les utilisez. Juste l'essayer. @package et / ou @subpackage est vraiment votre décision. Par exemple, je n'utilise pas @category du tout et @subpackage est tout après le "deuxième" espace de noms. Laissez-moi vous expliquer: je suis la norme PSR-0, où un package est structuré dans \ @package @subpackage
J'utilise @package pour le nom du package Ce fichier appartient à ... surprise :) par exemple, si son plugin appelé XYZ le @package pour tous les fichiers appartenant à ce paquet.
Pour Doxygen (que j'utilise), il n'y a pas de @subpackage Bien que vous puissiez faire la vôtre. Par exemple: http://www.doxygen.nl/manual/commands.html < / p>
Pour Doxygen, vous pouvez utiliser quelque chose comme @Package My.Awesome.Package qui le brise vers 'Sub Packages'
Vous pouvez vraiment l'utiliser pour quelque chose aussi longtemps que cela a du sens et est cohérent. d'abord décider ce que vous voulez utiliser, puis examinez les recommandations / docs pour cette application, car ils sont tous différents
Si vous avez rencontré cette réponse en 2020, au lieu de cela, vous devez utiliser @ Paquet pour fournir la sous-division logique requise.
Selon https://docs.phpdoc.org /Latest/Guide/references/phpdoc/tags/category.html et https://docs.phpdoc.org/latest/guide/references/phpdoc/tags/subpackage.html :
@category et @subpackage est considéré comme obsolète, alors s'il vous plaît ne les utilisez plus.
Selon le site Web phpdoc.org, à propos de la catégorie et de la sous-package: "Cette balise est considérée comme obsolète et peut être supprimée dans une future version de phpdocumentation. Il est recommandé d'utiliser la capacité de la balise @package à fournir plusieurs niveaux."