@api en @internal in PHPDoc
Vaak gebruik ik in PHPDoc de tag @api en de tegenhanger @internal, bijvoorbeeld:
Bij nader inzien is dat echter misschien onzinnig: API versus interne methode komt immers al tot uitdrukking in public (@api) versus private (@internal). Hoe kijken jullie hier tegenaan?
Code (php)
Bij nader inzien is dat echter misschien onzinnig: API versus interne methode komt immers al tot uitdrukking in public (@api) versus private (@internal). Hoe kijken jullie hier tegenaan?
Ik zou 1 van de 2 gebruiken. Symfony heeft voor @internal gekozen ipv @api.
Deze annotations hebben niet heel veel zin op method niveau, meer op class niveau. Op method niveau kun je dit inderdaad al aan de visibility zien. Maar er zijn bijvoorbeeld ook classes die iedereen kan gebruiken, maar die als internal beschouwd moeten worden (denk bijv. aan XmlUtils die Symfony gebruikt voor het parsen van XML bestanden).
Deze annotations hebben niet heel veel zin op method niveau, meer op class niveau. Op method niveau kun je dit inderdaad al aan de visibility zien. Maar er zijn bijvoorbeeld ook classes die iedereen kan gebruiken, maar die als internal beschouwd moeten worden (denk bijv. aan XmlUtils die Symfony gebruikt voor het parsen van XML bestanden).