PHP Depend и @ package-annotations

Question

Аналогично Какой смысл в аннотациях пакетов? , я запускаю pdepend с разделом нашего исходного кода в поисках проблем. Тем не менее, он выплевывает следующее:

The parser doesn't detect package informations within the analyzed project, please check the documentation blocks for @package-annotations or use the --bad-documentation option.

Что это на самом деле означает, как это исправить и где?

Answer 1

Из документации PHPDocumentor для аннотации @package

Пакеты используются, чтобы помочь вам логически сгруппировать связанные элементы. Вы пишете классы для группировки связанных функций и данных вместе, а phpDocumentor представляет содержимое файлов (функций, определяет и включает) как «процедурные страницы». Пакет используется для группировки классов и процедурных страниц таким же образом, как каталог объединяет связанные файлы.

Например, все валидаторы в Zend Framework принадлежат пакету Zend_Validate, потому что концептуально они являются именно этим. Когда PHPDocumentor создает документацию, вы можете перейти к пакету Zend_Validate и увидеть в нем все конкретные классы валидатора.

PHPDepend, очевидно, хочет, чтобы вы использовали аннотацию для создания правильной документации (отсюда и возможность использовать --bad-documentation). Проверьте страницу, которую я цитировал, чтобы увидеть, как использовать аннотации.