использовать пространство имен в @param - PullRequest
Новая
       15

использовать пространство имен в @param

8 голосов
/ 09 декабря 2011

Хорошая ли практика включать пространства имен для классов в аннотации @param?Я знаю, что phpdoc не поддерживает пространства имен, но как будут действовать другие инструменты, такие как phpdox или Doxygen?

Какой способ лучше / чаще встречается? 

namespace foo\someNamespace;
use foo\someOtherNamespace\MyOtherClass;

--- with namespace ---

/**
 * @param \foo\someOtherNamespace\MyOtherClass $otherClass
 */
class myClass(MyOtherClass $otherClass)
{
    // do something
}

--- without namespace ---

/**
 * @param MyOtherClass $otherClass
 */
class myClass(MyOtherClass $otherClass)
{
    // do something
}

1 Ответ

1 голос
/ 19 декабря 2011

Пространство имен является частью полного имени класса. Поэтому, если вы не добавите пространство имен к имени класса в @param, вы получите неправильный тип.

Лично я думаю, что пространства имен очень скоро станут главным критерием организации классов в PHP. Таким образом, инструменты документации все должны будут использовать их.

...