Определение пространств имен в синтаксисе phpDoc

Question

Может кто-нибудь сказать мне, как правильно определить пространства имен php в синтаксисе phpDoc? Или @package не рекомендуется в phpDoc, поскольку пространства имен более или менее определяют пакет?

Если их нет, есть ли общий способ документировать пространства имен, в которых находится документ?

Answer 1

В phpDoc нет концепции пространств имен, но вы можете (и, вероятно, должны) использовать для этого @package.

Вы можете взглянуть на документацию phplint , чтобы увидеть, как они форматируют пространства имен.

Answer 2

@ пакет Должен использоваться в каждом docblock каждого файла вашего проекта, вы также можете использовать @subpackage.@package не считается устаревшим и будет правильным способом определения ваших пространств имен.

Answer 3

Вы можете взглянуть на DocBlox ;это генератор документации API, который поддерживает пространства имен.

И, чтобы более четко ответить на ваш вопрос: насколько мне известно, пакеты считаются устаревшими из-за изобретения пространств имен.Если вы прочтете спецификацию PSR-0, вы увидите, что она пытается предоставить пакет в качестве второй части пространства имен;сначала быть продавцом.

Answer 4

Документация phpDoc гласит:

Тег @package может использоваться в качестве дополнения или дополнения к пространствам имен.Пространства имен обеспечивают функциональное подразделение Структурных элементов, где тег @package может обеспечить логическое подразделение, с помощью которого элементы могут быть сгруппированы с другой иерархией.

Если по всем направлениям логические и функциональные подразделения равныНЕ РЕКОМЕНДУЕТСЯ использовать тег @package, чтобы избежать накладных расходов на обслуживание.

https://www.phpdoc.org/docs/latest/references/phpdoc/tags/package.html