Comment documenter correctement les types d'objets aliasés?

Question

Si j'ai importé une classe sous un pseudonyme:

use My\Other\ClassName as OtherClass; 

Comment dois-je documenter les types de cette catégorie? Est-ce que j'utilise l'alias ou non?

a)@return \My\Other\ClassName

b)@return OtherClass

c) Une autre façon?

Answer 1

PHPDoc soutient des cours qualifiés, les classes relatives, les alias et les références à l'auto (statique, $ this)

http://docs.phpdoc.org/guides/types.html

La pratique la plus courante que j'ai vu est d'utiliser les noms de classe entièrement qualifiés (par exemple \ My \ Other \ ClassName) qui, à mon avis, est le meilleur moyen de documenter des classes externes puisque la personne lisant le bloc doc n'a pas besoin de regarder dans un endroit différent pour voir ce à quoi se réfère OtherClass.

Si vous utilisez PhpStorm, jetez un oeil à une question que je posais récemment: Disable import of classes for PHPDoc